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

Investigate alternative documentation generator systems #458

Open
doerfli opened this issue Jun 27, 2024 · 0 comments
Open

Investigate alternative documentation generator systems #458

doerfli opened this issue Jun 27, 2024 · 0 comments
Assignees
@doerfli
Labels
documentation Improvements or additions to documentation
Milestone
GIF v3

Comments

@doerfli
Copy link
Contributor

doerfli commented Jun 27, 2024

current natspec generation setup requires manual referencing and linking of contracts in adoc files and is therefor prone to failures. Investigate if some system exists, that supports automatic extraction of natspec docs.
@doerfli doerfli added the documentation Improvements or additions to documentation label Jun 27, 2024
@doerfli doerfli added this to the GIF v3 Audit Ready milestone Jun 27, 2024
@doerfli doerfli self-assigned this Jun 27, 2024
@doerfli doerfli modified the milestones: GIF v3 Audit Ready, GIF v3 Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@doerfli doerfli

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
GIF v3
Development

No branches or pull requests
1 participant
@doerfli