Examples are not that effective.
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 459
- Forks
- 359
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 73
Description
"Nice" feedback from Qdev:
As it turns out examples notebook are not that effective. (Also hard to discover)
The tutorial is almost useless. For a new user the mocks are just noise and add complexity.
No simple example to be found.
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 examples notebooks and tutorial to identify why they are hard to discover and why the mocks add complexity for new users. Define a simple introductory example and a clearer tutorial path, then verify that a new user can find and follow the examples without unnecessary mock-related setup.
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