django / django/new-features

Include DryORM tool in the documentation

Open
#203 15 comments 25 reactions 0 assignees View on GitHub
Django Core Documentation
Dominant language
No language data
Stars
188
Forks
7
PR merge metrics
No merged PRs in 30d

Description

### Code of Conduct

- [x] I agree to follow Django's Code of Conduct

### Feature Description

Include DryORM snippets in the Django documentation, specifically around confusing or complex topics.

### Problem

There are several parts of the ORM that are a bit difficult to wrap your head around. Several of the [notes on the queries topic page](https://docs.djangoproject.com/en/6.1/topics/db/queries/) are complex ideas. Allowing readers to see the queries it generates and consider what the ORM is actually doing should improve understanding.

### Request or proposal

proposal

### Additional Details

DryORM is a tool from @omaraboumrad. It's been used by community members in Trac tickets and discussions to help others. The ORM is one of the best parts of Django and this tool does a fantastic job of showing what it's doing under the hood. Prominently displaying this in our documentation (maybe even the landing page!?!) could go a long way to helping people get comfortable with Django.

### Implementation Suggestions

Currently @omaraboumrad manages this tool himself. The community has linked to other community maintained solutions such as Django Packages, Jazzband and Django Commons. However, this may be a little different as it's an interactive tool.

I think we'll be most productive if we **hold off on the discussion around how to host the tool** and **first discuss whether this tool should be included** in the documentation. I think it's reasonable to have concerns about an interactive tool being a part of the documentation and is fair game for initial discussion though.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the linked Django queries topic page and the issue discussion about whether DryORM belongs in the documentation. The issue does not identify documentation files, tests, hosting, or a settled implementation; done would require agreement on inclusion and how the tool should be presented.

Written by the indexing model from the issue text.

Assessment

Tech stack
django
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.