rucio/documentation

Investigate replacements for MKDocs

Open

#840 opened on Jul 7, 2026

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (67 forks)auto 404
Discussion neededhelp wanted

Repository metrics

Stars
 (4 stars)
PR merge metrics
 (PR metrics pending)

Description

Mkdocs 2.0 looks like it may cause problems for the py client documentation (e.g. autodoc plugins will probably break), according to the Material blog

The blog itself is pretty biased but it raises some good points, so we should investigate some replacements.

Contributor guide

Research direction
Research alternative static site generators for documentation that work well with Python autodoc plugins, such as Sphinx or others. Compare features, plugin compatibility, and migration effort.
Tech stack
python
Domain
documentation
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonMKDocs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70