opensafely / opensafely/documentation
Migrate away from Material for MkDocs
Open
Nobody has claimed this yet.
deck scrubbing
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
Material for MkDocs is now in maintenance mode for 12 months commencing November 2025.
MkDocs also looks as if it's not frequently maintained.
We should consider moving to something else, which could be Zensical, the follow-up project, or something else.
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 current documentation setup and the linked Material for MkDocs and Zensical references. Compare the available replacement options and define the migration scope. Done means an alternative is agreed and the documentation works with the chosen system.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100