API theme
Open
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 41
- Forks
- 88
- Avg merge
- 8d 9h
- Merged PRs (30d)
- 3
Description
The current API documentation puts all the functions in the same web page, which seems not clear. It would be better to use the same style as numpy documentation where each page contains only one function.
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 at the current API documentation entry point and inspect how functions are grouped into pages. Compare its organization with the numpy documentation style; the work is done when each function has its own API documentation page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100