openedx / openedx/api-doc-tools
Allow better customization of the /api-docs page.
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
A lot of value in documentation comes from introduction paragraphs, section structure, etc.
Right now, the /api-docs page is a big list of endpoints.
How can we allow for better customization of the /api-docs page to make it a better experience for consumers of API documentation?
There is a lot of room for discovery and experimentation here.
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 names no files, tests, or entry points. Start by locating how the /api-docs page is generated, then define a concrete customization scope and acceptance criteria; the issue currently describes discovery and experimentation rather than a specific done state.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100