Document API
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 12
- Forks
- 49
- Avg merge
- 27m
- Merged PRs (30d)
- 4
Description
We should be able to generate the doc from openapi.json.
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 locating openapi.json and the documentation build entry point, then determine how API documentation is currently produced. The issue does not specify a generator, output location, or expected format, so confirm those requirements before implementation. Done means the documentation can be generated reproducibly from openapi.json.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100