Documentation API
Open
Nobody has claimed this yet.
request
- Dominant language
- Less
- Stars
- 680
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
Are we planning to have an API for individual pieces of documentation? (So that someone can, say, look up a function in an editor?) ;-)
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
The issue asks whether an API for individual documentation pieces is planned, such as looking up a function from an editor, but names no files, tests, or entry points. First review the repository structure and existing documentation-generation or publishing workflow; done would require an agreed scope and implementation plan for that API.
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
- 20/100