Backend · Any LLM tool that fetches it
Django 6 & Ninja / DRF llms.txt
An llms.txt for a Django 6 & Ninja / DRF project: a short Markdown map of what it is and where the key docs and code live.
- Path
- llms.txt
- Loads
- Fetched on request
- Format
- Markdown index (.txt)
- Used by
- Any LLM tool that fetches it
What this file tells the agent
An llms.txt gives language models and agents a short Markdown map of your Django 6 & Ninja / DRF project: what it is and where the key docs and code live, so a tool that fetches it can go straight to the right files.
- Use asynchronous ORM operations (aget(), acreate(), afirst()) inside async def view handlers.
- Prevent N+1 query catastrophes: always apply select_related() for ForeignKey/OneToOne and prefetch_related() for ManyToMany/reverse relationships.
- Enforce Django Ninja schemas or DRF serializers with explicit field typing; never return raw unvalidated model instances.
- Never alter existing committed migration files; generate new sequential migrations via python manage.py makemigrations.
- Use GeneratedField for computed database columns rather than redundant model save() recalculations.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
# Discouraged: Synchronous blocking query inside async context & N+1 queries
@router.get("/articles/{article_id}")
async def get_article(request, article_id: int):
article = Article.objects.get(id=article_id) # Synchronous blocking call!
return {"id": article.id, "title": article.title, "author": article.author.username} # N+1 DB hit!from ninja import Router, Schema
from django.shortcuts import aget_object_or_404
from .models import Article
router = Router()
class ArticleOut(Schema):
id: int
title: str
author_name: str
@router.get("/articles/{article_id}", response=ArticleOut)
async def get_article(request, article_id: int):
# Asynchronous fetch with joined relationship preventing N+1
article = await Article.objects.select_related("author").aget(id=article_id)
return {
"id": article.id,
"title": article.title,
"author_name": article.author.username,
}Install it in one command
- 01
Go to your project root
The file goes at llms.txt, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Nothing loads llms.txt automatically. Serve it at your site root, or point agents to it from CLAUDE.md or AGENTS.md.
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/llms-txt/python-django" -o "llms.txt"
writes llms.txt
llms.txt
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Django 6 & Ninja / DRF
Questions
- What is llms.txt?
- llms.txt is an open proposal for a short Markdown file that lists a project's key docs and links, so AI tools can find them without crawling every page.
- Where should llms.txt be deployed?
- At /llms.txt on your documentation site, or in your repository root. Tools read it when they fetch it; nothing loads it automatically.