Documentation overhaul
Open
Nobody has claimed this yet.
documentation
DX
- Dominant language
- No language data
- Stars
- 12
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
New documentation audit and documentation reorganisation to increase the quantity and quality of our docs, in line with the product strategy.
Intended outcome
- New documentation structure that scales better
- New documentation content that covers more Django and Python fundamentals
- New guidelines for contributors to improve the quality of documentation contributions
More information
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 with the documentation reorganisation in issue #6781 and compare it with the Wagtail product strategy. Review the existing documentation structure and contributor guidance before defining the scope. Done means a scalable structure, broader Django and Python fundamentals coverage, and updated contribution guidelines.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100