Skip to content

[DOCS] Auto-gen doc pages based on codebase#253

Open
maxnorm wants to merge 126 commits intoPerfect-Abstractions:mainfrom
maxnorm:main
Open

[DOCS] Auto-gen doc pages based on codebase#253
maxnorm wants to merge 126 commits intoPerfect-Abstractions:mainfrom
maxnorm:main

Conversation

@maxnorm
Copy link
Collaborator

@maxnorm maxnorm commented Dec 21, 2025

Summary

Create a complete CI workflow to generate automatically Compose documentation based on the codebase

  • Mirror /src folder into /docs/library/ on the website
  • Parse & process forge doc to convert into MDX files
  • Enhance generated content with AI.

Changes Made

a lot

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 30 commits December 30, 2025 10:06
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