OpenZeppelin / OpenZeppelin/compact-contracts
Add docgen
Open
Nobody has claimed this yet.
enhancement
stale
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
It'd be nice to use a docgen tool for the docsite. Not sure how feasible it is with iterating .compact files
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
No files or tests are named. Start by inspecting the docsite and how .compact files are iterated, then assess whether a docgen tool can support that workflow. Done requires a concrete feasibility conclusion and agreed implementation scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100