Document internal API
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 413
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 21
Description
Over the last month we've invested quite some time in centralizing our code and building an internal API. Our code is ready and it's awesome to see it being used in more and more commands. To further promote its usage, I suggest that we look into publishing API documentation on our docs. Ideally, it's something that we'd generate from JSDoc in our docs. This will also make it clear where we need to improve, because the same information is displayed by the IDE for API consumers.
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, tests, or entry points are named. Start by identifying the internal API and the existing documentation structure, then determine how JSDoc-based API documentation could be published; done means the internal API is documented in the project docs and the generated information is useful to API consumers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100