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

[Enhancement]: ANY-API consider using a doc-generator for the API reference #740

Open
aelmanaa opened this issue May 3, 2022 · 0 comments
Open

[Enhancement]: ANY-API consider using a doc-generator for the API reference #740

aelmanaa opened this issue May 3, 2022 · 0 comments
Labels
Any API enhancement Enhance existing content or processes evm

Comments

@aelmanaa
Copy link
Collaborator

aelmanaa commented May 3, 2022

What would you like us to improve?

Currently the API reference is done manually.
consider some doc generators like this one https://github.com/OpenZeppelin/solidity-docgen

How important it is?

Easier for maintenance in the long run. it will also help in maintaining API references for several versions: 0.8 ; 0.7..ETc
@aelmanaa aelmanaa added enhancement Enhance existing content or processes evm Any API labels May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Any API enhancement Enhance existing content or processes evm
Projects
None yet
Milestone
No milestone
Development

When branches are created from issues, their pull requests are automatically linked.

aelmanaa/doc-generator smartcontractkit/documentation
1 participant
@aelmanaa