Documentation Issue
Summary
We need help writing accurate documentation for all facets and modules in our library. Currently, only the Diamond and Owner facets are documented, while 8 other major areas have zero or minimal documentation.
Location
Documentation website: https://compose.diamonds/docs/library/
Source code to document:
- src/access/AccessControl/ - 11 subdirectories (Admin, Data, Grant, Revoke, Renounce, Pausable, Batch, Temporal)
- src/token/ERC20/ - 8 subdirectories (Data, Approve, Transfer, Burn, Mint, Metadata, Permit, Bridgeable)
- src/token/ERC721/ - 7 subdirectories including Enumerable sub-facets
- src/token/ERC1155/ - 6 subdirectories (Data, Approve, Transfer, Burn, Mint, Metadata)
- src/token/ERC6909/ - 6 subdirectories (Data, Approve, Transfer, Burn, Mint, Operator)
- src/token/Royalty/ - RoyaltyFacet.sol, RoyaltyMod.sol
- src/interfaceDetection/ERC165/ - ERC165Facet.sol, ERC165Mod.sol
- src/libraries/ - Utils.sol, NonReentrancyMod.sol
Priority order:
- ERC-20, ERC-721, ERC-1155, ERC-6909
- , AccessControl, Royalty, ERC-165, Utils, NonReentrancy
Recommended change
Example of existing documentation to follow:
Feel free to review the current pages formatting and propose ideas to improve content accuracy, layout, and make the overall documentation easy to understand and use
Additional Context
Helpful Information
Have a question? Please check our contribution guide first - your answer might already be there!
Want to discuss something? For general questions, ideas, or brainstorming, please browse our discussions or start a new one.
You can also join our Discord to discuss the documentation issue.
Documentation Issue
Summary
We need help writing accurate documentation for all facets and modules in our library. Currently, only the Diamond and Owner facets are documented, while 8 other major areas have zero or minimal documentation.
Location
Documentation website: https://compose.diamonds/docs/library/
Source code to document:
Priority order:
Recommended change
Example of existing documentation to follow:
Feel free to review the current pages formatting and propose ideas to improve content accuracy, layout, and make the overall documentation easy to understand and use
Additional Context
Helpful Information
Have a question? Please check our contribution guide first - your answer might already be there!
Want to discuss something? For general questions, ideas, or brainstorming, please browse our discussions or start a new one.
You can also join our Discord to discuss the documentation issue.