Repository navigation
[DOCS] Help write the library documentation #369
Description
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.
Activity
Jayy4rl commentedon Aug 14, 2026
@maxnorm would like to work on this
maxnorm commentedon Aug 15, 2026
Heyyy, great news! Which part of the library is the more interesting to you?
For the docs, you have multiple choice to do the job:
The easiest way would be to generate the page based on specific source and update it after.
All of this need more work to make a full automated docs generation pipeline. It not part of the issues, it's really the actual doc pages.
I hope it make sense. If you have any questions, feel free to reach out.
Jayy4rl commentedon Aug 24, 2026
Oh thanks, that would be very helpful. I could start from the token implementations and work my way out. I’ll be sure to drop a comment here if I run into any blockers
Jayy4rl commentedon Sep 7, 2026
@maxnorm so the workflow ran into issues, couldn't use that. I followed the structure used on the existing pages instead. Worked on ERC20 Data Facet so you could look into it before i go ahead with the rest. Can review the PR here: #397
maxnorm commentedon Sep 8, 2026
@Jayy4rl that's what I thought. I think i'll remove the workflow. With current ai and agents, it easier to duplicate a current page.
Thanks for your help on the doc 🫡