Skip to content

Switch from MkDocs to Zensical#2233

Draft
ObadaS wants to merge 3 commits intodevelopfrom
documentation_zensical
Draft

Switch from MkDocs to Zensical#2233
ObadaS wants to merge 3 commits intodevelopfrom
documentation_zensical

Conversation

@ObadaS
Copy link
Collaborator

@ObadaS ObadaS commented Mar 5, 2026

A brief description of the purpose of the changes contained in this PR.

Switch to Zensical for the documentation

MkDocs is unmaintained, and MkDocs material has stopped development to focus on building Zensical.

Because MkDocs 2.0 is not compatible with MkDocs 1.x, and for some other reasons that are listed in the link, I am proposing we switch to Zensical.

The switch is not a priority, at least unless a big CVE is found on MkDocs 1.x which we currently use.

Zensical is still missing some features that we use:

Checklist

  • Code review by me
  • Hand tested by me
  • I'm proud of my work
  • Code review by reviewer
  • Hand tested by reviewer
  • CircleCi tests are passing
  • Ready to merge

@Didayolo
Copy link
Member

Didayolo commented Mar 5, 2026

Is this going to take effect simply by merging it?

How will docs.codabench.org get updated?

Will the interface be the same, or will it be different? (I guess for this point I can try locally?)

@ObadaS
Copy link
Collaborator Author

ObadaS commented Mar 5, 2026

It should take effect by simply merging it since I updated the workflow, however I am not sure if we need to delete the old branch first or not.

docs.codabench.org will get updated automatically once the new workflow runs.

You can get an idea on the new look by visiting Zensical's documentation : https://zensical.org/docs/get-started/

Or by building locally :

uv run zensical serve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants