Update Solidity docgen for prc-3

Author: SebastienGllmt

packages/contracts/evm-contracts/contracts/README.md

@@ -50,6 +50,8 @@ Facilitating monetization
 
 {{ERC1967}}
 
+{{ITokenUri}}
+
 {{NativeNftSaleProxy}}
 
 {{GenericPaymentProxy}}

packages/contracts/evm-contracts/contracts/token/IInverseAppProjectedNft.sol

@@ -4,9 +4,10 @@ pragma solidity ^0.8.13;
 import {IInverseProjectedNft} from "./IInverseProjectedNft.sol";
 
 /// @dev A Paima Inverse Projection NFT where initialization is handled by the app-layer.
-/// A standard ERC721 that can be freely minted and stores an unique <minter, userTokenId> pair (used in tokenURI) when minted.
+/// A standard ERC721 that can be freely minted and stores an unique `<minter, userTokenId>` pair (used in tokenURI) when minted.
+/// See PRC3 for more.
 interface IInverseAppProjectedNft is IInverseProjectedNft {
-    /// @dev Emitted when the globally-enforced tokenId in combination with an unique <minter, userTokenId> pair is minted.
+    /// @dev Emitted when the globally-enforced tokenId in combination with an unique `<minter, userTokenId>` pair is minted.
     event Minted(uint256 indexed tokenId, address indexed minter, uint256 indexed userTokenId);
 
     /// @dev Mints a new token to address `_to`

packages/contracts/evm-contracts/contracts/token/IInverseBaseProjectedNft.sol

@@ -5,6 +5,7 @@ import {IInverseProjectedNft} from "./IInverseProjectedNft.sol";
 
 /// @dev A Paima Inverse Projection NFT where initialization is handled by the base-layer.
 /// A standard ERC721 that accepts calldata in the mint function for any initialization data needed in a Paima dApp.
+/// See PRC3 for more.
 interface IInverseBaseProjectedNft is IInverseProjectedNft {
     /// @dev Emitted when the globally-enforced tokenId is minted, with `initialData` provided in the `mint` function parameters.
     event Minted(uint256 indexed tokenId, string initialData);

packages/contracts/evm-contracts/contracts/token/IInverseProjectedNft.sol

@@ -6,6 +6,7 @@ import {IERC4906} from "@openzeppelin/contracts/interfaces/IERC4906.sol";
 import {ITokenUri} from "./ITokenUri.sol";
 
 /// @dev A standard ERC721 that can be burned and has a special tokenURI function accepting a custom base URI.
+/// See PRC3 for more.
 interface IInverseProjectedNft is IERC4906, IERC721Metadata {
     /// @dev Emitted when `baseExtension` is updated from `oldBaseExtension` to `newBaseExtension`.
     event SetBaseExtension(string oldBaseExtension, string newBaseExtension);

packages/contracts/evm-contracts/contracts/token/InverseAppProjectedNft.sol

@@ -16,6 +16,7 @@ struct MintEntry {
 }
 
 /// @dev A standard ERC721 that accepts calldata in the mint function for any initialization data needed in a Paima dApp.
+/// See PRC3 for more.
 contract InverseAppProjectedNft is IInverseAppProjectedNft, ERC721, Ownable {
     using Strings for uint256;
 

packages/contracts/evm-contracts/contracts/token/InverseBaseProjectedNft.sol

@@ -11,6 +11,7 @@ import {IInverseBaseProjectedNft} from "./IInverseBaseProjectedNft.sol";
 import {ITokenUri} from "./ITokenUri.sol";
 
 /// @dev A standard ERC721 that accepts calldata in the mint function for any initialization data needed in a Paima dApp.
+/// See PRC3 for more.
 contract InverseBaseProjectedNft is IInverseBaseProjectedNft, ERC721, Ownable {
     using Strings for uint256;
 

packages/contracts/evm-contracts/docs/templates/contract.hbs

@@ -1,4 +1,4 @@
-<ContractHeader githubLink="https://github.com/PaimaStudios/paima-engine/tree/master/packages/evm-contracts/{{__item_context.file.absolutePath}}" anchor="{{~anchor~}}">
+<ContractHeader githubLink="https://github.com/PaimaStudios/paima-engine/tree/master/packages/contracts/evm-contracts/{{__item_context.file.absolutePath}}" anchor="{{~anchor~}}">
     ### {{name}}
 </ContractHeader>
 

packages/contracts/evm-contracts/docs/templates/helpers.js

@@ -2,6 +2,8 @@ const { version } = require('../../package.json');
 
 module.exports['escapeChars'] = input => {
   if (input == null) return 'No description given';
+  // escape the curly braces (replace them with \{ )
+  // useful to escape cases like {IERC721Receiver-onERC721Received}
   return input.replace(/\{([a-zA-Z0-9-]+)\}/g, '\\{$1\\}');
 };