Rework the API docs
Open
Nobody has claimed this yet.
.doc
- Dominant language
- Python
- Stars
- 71
- Forks
- 91
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 22
Description
Author: @quba42 (quba42)
Redmine Issue: 8643, https://pulp.plan.io/issues/8643
I would like to systematically go through the strings used for the API docs, to ensure they provide all the critical information for users.
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
Start by reviewing the API documentation strings and the scope recorded in Redmine issue 8643. Define the information users need for each string, then verify that every API doc entry provides that critical context and update the affected documentation.
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