Docs: document Downloads API
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 700
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 11
Description
Summary
It seems like the existence of the Downloads API is not documented, other than by its presence in the source code.
I think it'd be a good idea to document its existence somewhere on the site itself, probably under an "API" link in the index on the bottom of each page? Since I think that's what most people would expect, from how other sites do it, and there have been issue(s) in the past with APIs being forgotten about and stopping working.
Contributor guide
No contributing guide indexed for this repository
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 downloads/api.py, then inspect the site index and page footer to determine where an API link belongs. Document the Downloads API on the site and make it discoverable from the navigation; done when visitors can find the API information through the site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100