Skip to content

Library doc pages generated based on source file#310

Open
maxnorm wants to merge 154 commits intomainfrom
docs
Open

Library doc pages generated based on source file#310
maxnorm wants to merge 154 commits intomainfrom
docs

Conversation

@maxnorm
Copy link
Collaborator

@maxnorm maxnorm commented Mar 25, 2026

Summary

Created a documentation generation action based on source file code from facets and modules

Changes Made

  • add new actions
  • a lot of reviews from contributors and maintainers to ensure content accuracy

Checklist

Before submitting this PR, please ensure:

  • Code follows the Solidity feature ban - No inheritance, constructors, modifiers, public/private variables, external library functions, using for directives, or selfdestruct

  • Code 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 fmt

  • Existing 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 test and ensure everything works

  • Documentation updated - If applicable, update relevant documentation

Make sure to follow the contributing guidelines.

Additional Notes

maxnorm and others added 26 commits March 12, 2026 19:51
add readme for doc gen, action only on trigger
Add docs generation for library
@netlify
Copy link

netlify bot commented Mar 25, 2026

Deploy Preview for compose-diamonds ready!

Name Link
🔨 Latest commit 5755f24
🔍 Latest deploy log https://app.netlify.com/projects/compose-diamonds/deploys/69c3fbc392f81400088af17f
😎 Deploy Preview https://deploy-preview-310--compose-diamonds.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link

Coverage Report

Coverage

Metric Coverage Details
Lines 79% 1560/1981 lines
Functions 92% 445/483 functions
Branches 74% 161/217 branches

Last updated: Wed, 25 Mar 2026 15:15:28 GMT for commit 5755f24

@github-actions
Copy link

Gas Report

No gas usage changes detected between main and docs.

All functions maintain the same gas costs. ✅

Last updated: Wed, 25 Mar 2026 15:16:02 GMT for commit 5755f24

@maxnorm maxnorm changed the title Library documentation pages based on source file Library doc pages generated based on source file Mar 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant