What problem does it solve?
Docs sites break in ways that are hard to notice until after deploy—nav ordering drifts from the filesystem, internal links and anchors go stale, assets go missing or become orphaned, and CI/workflow steps quietly rot.
Core Features & Use Cases
- Nav vs filesystem integrity: ensures zensical.toml navigation matches docs/**/*.md and flags missing-or-unlisted pages.
- Internal link and anchor validation: verifies markdown links (including #anchors) resolve to actual headings/sections.
- Build/deploy workflow sanity checks: validates .github/workflows/docs.yml triggers, pinned action versions, permissions, and the expected build command.
- CSS/JS and asset reference audits: checks extra_css/extra_javascript files exist, selectors/classes are present, and docs/assets/or static files aren’t orphaned.
Quick Start
Run the docs-site audit to verify nav ordering, internal links/anchors, referenced assets, and the docs GitHub Pages workflow are all consistent for deployment.