liquidmetal-dev / liquidmetal-dev/site
Clearer CAPMVM api docs
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
Using something like https://github.com/ahmetb/gen-crd-api-reference-docs although maybe not exactly that because wow is it unpleasant to use. (also not actively developed)
Contributor guide
No contributing guide indexed for this repository
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 the CAPMVM API documentation needs described in the issue and compare the proposed gen-crd-api-reference-docs tool. Determine the documentation entry points and the expected API reference scope before choosing an approach. Done means the CAPMVM API docs are clearer and the selected generation approach is documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100