Migrate from mkdocs to something else
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 9
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
We are using mkdocs to generate documentation of multiple projects (python-scraperlib, python-libzim, ...).
The community is moving away from MkDocs due multiple drama.
I feel like we should probably follow the community and move to ProperDocs or Zensical.
See e.g. the very opinionated input from Material for MkDocs team: https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/
We should probably try to migrate a first project to what feels like the best future for our needs (and the plugins we are currently using).
Contributor guide
No contributing guide indexed for this repository
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 documentation setup for python-scraperlib and python-libzim, including the plugins currently in use. Compare ProperDocs and Zensical against the projects' documentation needs, then migrate one selected project and verify that its documentation builds successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100