Docs: further worked contextual tutorial examples
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 150
- Forks
- 23
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
Quoting @bnlawrence in an external conversation thread at a point concerning the necessary terseness of the documentation:
I think the API docs are fine, we just need more tultorials working through real examples. If we can get the indexing right that puts context on the abstraction and terseness necessary in the API.
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
No files, tests, or entry points are named. Review the existing documentation and tutorials first, then identify real contextual examples and how the documentation index should expose them. Done means the worked examples are added and indexed, but the issue does not define their number or scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100