Better tutorial/example structure
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 216
- Forks
- 16
- Avg merge
- 16h 2m
- Merged PRs (30d)
- 3
Description
Possible options:
- just a list
- stick to
sphinx-gallery - custom solution using
sphinx-design
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
Compare the three options named in the issue: a simple list, sphinx-gallery, and a custom sphinx-design solution. First inspect the existing tutorial and example organization and the project's documentation setup. Done means the project has chosen and implemented a clearer structure, with the relevant examples organized consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100