Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Auto-generate forge-std documentation using its NatSpec #1448

Open
zerosnacks opened this issue Feb 11, 2025 · 0 comments
Open

Auto-generate forge-std documentation using its NatSpec #1448

zerosnacks opened this issue Feb 11, 2025 · 0 comments
Labels
A-reference Area: reference T-tracking Type: tracking issue

Comments

@zerosnacks
Copy link
Member

zerosnacks commented Feb 11, 2025 •
edited
Loading

We currently manually maintain the sections in https://book.getfoundry.sh/reference/forge-std/, I would like this to be replaced with an automated process that ideally uses purely NatSpec and file name grouping. This makes it more easy to maintain and for users to find an up-to-date reference.

Related: foundry-rs/forge-std#653
@zerosnacks zerosnacks added T-enhancement Type: enhance existing docs T-tracking Type: tracking issue A-reference Area: reference and removed T-enhancement Type: enhance existing docs labels Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-reference Area: reference T-tracking Type: tracking issue
Projects
No open projects
Foundry Book
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zerosnacks