Your current Documentation is broken
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 111
- Forks
- 23
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 4
Description
Documentation found here: https://chai.readthedocs.io/en/develop/
Which is linked in your readme has major sections missing.
For example the tutorial section is a stub found here: https://chai.readthedocs.io/en/develop/tutorial.html
Code documentation is also a stub found here:
https://chai.readthedocs.io/en/develop/code_documentation.html
I came across your library and would like to use it, but I'd love to be able to see what it does first :)
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 README links and the tutorial.html and code_documentation.html pages on the develop Read the Docs site. Compare the linked pages with the available project material to identify the missing sections. Done means the tutorial and code documentation are no longer stubs and the README documentation links lead to useful content.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100