smartcontractkit / smartcontractkit/documentation
[Enhancement]: ANY-API consider using a doc-generator for the API reference
Open
Nobody has claimed this yet.
Any API
enhancement
evm
- Dominant language
- MDX
- Stars
- 526
- Forks
- 478
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 75
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the API reference is currently maintained manually and compare its needs with the linked solidity-docgen project. Done means selecting and integrating a documentation generator that can maintain API references across versions such as 0.8 and 0.7.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- solidity
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100