Skip to content

Track Zensical Migration #141

@Kilo59

Description

@Kilo59

This is a long-term tracking issue for migrating the documentation from the current MkDocs-Material stack to Zensical. Zensical is a high-performance, Rust-based documentation platform built by the original creators of Material for MkDocs.

Context
Zensical represents a direct evolution of the MkDocs ecosystem, featuring a Rust runtime (ZRX) for faster builds, a next-gen search engine (Disco), and a modular architecture. It is currently in alpha, and we should transition once it reaches feature parity with our existing stack.

Blockers & Prerequisites

Migration Action Plan (Estimated: 3–6 months)

  1. Shadow Build Verification
  • Once literate-nav is supported, install Zensical (pip install zensical).
  • Run zensical build locally against the existing mkdocs.yml.
  • Compare the output with the current Material site to ensure visual and structural parity.
  1. Switch Deployment
  • Switch the doc deployment step in CI from mkdocs build to zensical build.
  • Initially, mkdocs.yml can remain unchanged as Zensical provides backward compatibility for it.
  1. Modernize Config
  • Eventually transition to the native zensical.toml format and opt into the Rust-based optimization engine.

Verification

  • Run a shadow build and verify that all core pages and navigation are preserved.
  • Verify that the local search engine (Disco) is functional.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions