docs: create 'Common Pitfalls' guide
Open
Beginner friendly
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- Rust
- Stars
- 13
- Forks
- 5
- Avg merge
- 1h 49m
- Merged PRs (30d)
- 3
Description
New users often struggle with specific ORM concepts (e.g., select_related vs prefetch_related or async context managers).
Goal: Create a new page in the documentation listing common mistakes and their solutions.
Implementation hint: Add a new .mdx file in docs/doc/ and update sidebars.js.
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
Create a new MDX page under docs/doc/ covering common ORM mistakes such as select_related versus prefetch_related and async context managers, with practical solutions. Update sidebars.js to link the page; done means the guide is readable, complete for the listed pitfalls, and reachable in the documentation navigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100