API documentation should be exposed in /docs
Open
Beginner friendly
Nobody has claimed this yet.
hours
P3
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 611
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 49
Description
The API documentation currently lives only in the GitHub repository at https://github.com/mozilla/pontoon/blob/main/pontoon/api/README.md
We should deprecate that, and move it to the generated docs, likely under Developer Guide
https://pontoon.mozilla.org/docs/dev/
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 reading pontoon/api/README.md and the generated documentation under https://pontoon.mozilla.org/docs/dev/. Identify where Developer Guide pages are sourced and add the API documentation there, then ensure the repository README is deprecated or no longer the canonical location. Done means the API documentation is available through /docs under Developer Guide.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100