docs: release diamond-core docs and docs generation action/scripts from contract source#338
Conversation
[DOCS] Auto-generated Docs Pages
[DOCS] Auto-generated Docs Pages
[DOCS] Auto-generated Docs Pages
Add docs generation for library
✅ Deploy Preview for compose-diamonds ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Coverage Report
Last updated: Sat, 02 May 2026 19:33:31 GMT for commit |
Gas ReportNo gas usage changes detected between All functions maintain the same gas costs. ✅ Last updated: Sat, 02 May 2026 19:33:57 GMT for commit |
Summary
This PR adds and integrates the docs generation workflow for Compose contract documentation, including automation scripts and CI action updates. It also includes related documentation and site updates needed to publish and maintain generated docs.
Changes Made
Checklist
Before submitting this PR, please ensure:
Code follows the Solidity feature ban - No inheritance, constructors, modifiers, public/private variables, external library functions,
using fordirectives, orselfdestructCode follows Design Principles - Readable, uses diamond storage, favors composition over inheritance
Code matches the codebase style - Consistent formatting, documentation, and patterns (e.g. ERC20Facet.sol)
Code is formatted with
forge fmtExisting tests pass - Run tests to be sure existing tests pass.
New tests are optional - If you don't provide tests for new functionality or changes then please create a new issue so this can be assigned to someone.
All tests pass - Run
forge testand ensure everything worksDocumentation updated - If applicable, update relevant documentation
Changesets — If this PR changes publishable packages (
src/,cli/), changeset-bot will comment if a release note might be needed. You can add one when convenient or defer to maintainers.Make sure to follow the contributing guidelines.
Additional Notes