Skip to content

docs: switch from mkdocs to zensical - #2720

Merged
Hofer-Julian merged 1 commit into
prefix-dev:mainfrom
Hofer-Julian:switch-from-mkdocs-to-zensical
Aug 4, 2026
Merged

docs: switch from mkdocs to zensical#2720
Hofer-Julian merged 1 commit into
prefix-dev:mainfrom
Hofer-Julian:switch-from-mkdocs-to-zensical

Conversation

@Hofer-Julian

Copy link
Copy Markdown
Contributor

Replace mkdocs-material with zensical for building the documentation, same as prefix-dev/pixi#6572.

Migration

Fixes surfaced by the migration

  • Zensical's strict link validation caught a broken link in understanding_terminal_output.md.
  • index.md and rattler_index.md get frontmatter titles, since zensical derives titles from the filename when a page has no h1.
  • repo_url loses its trailing slash, which produced a double slash in the edit links.

How Has This Been Tested?

  • Let agent compare Zensical output with mkdocs output
  • Ran it locally

Replace mkdocs-material with zensical for building the documentation, same as prefix-dev/pixi#6572.

### Migration

- `zensical.toml` replaces `mkdocs.yml`
- `rattler_build_docs` now also writes the CLI navigation into `zensical.toml` between markers
- New `scripts/generate_llmstxt.py` generates `llms.txt` and `llms-full.txt` at the site root, with task dependencies split like in prefix-dev/pixi#6757.

### Fixes surfaced by the migration

- Zensical's strict link validation caught a broken link in `understanding_terminal_output.md`.
- `index.md` and `rattler_index.md` get frontmatter titles, since zensical derives titles from the filename when a page has no `h1`.
- `repo_url` loses its trailing slash, which produced a double slash in the edit links.

### How Has This Been Tested?

- Let agent compare Zensical output with mkdocs output
- Ran it locally
@Hofer-Julian
Hofer-Julian force-pushed the switch-from-mkdocs-to-zensical branch from 5ac9a99 to 26424d7 Compare August 4, 2026 13:12
@Hofer-Julian
Hofer-Julian marked this pull request as ready for review August 4, 2026 13:32
@Hofer-Julian
Hofer-Julian merged commit 376e412 into prefix-dev:main Aug 4, 2026
16 checks passed
@Hofer-Julian
Hofer-Julian deleted the switch-from-mkdocs-to-zensical branch August 4, 2026 13:34
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.

1 participant