Conversation
Documentation ReviewOverall this is a well-scoped migration PR. The changes are internally consistent and the test plan is clear. A few items worth confirming before merge: Needs verification before mergingCSS class compatibility ( .md-grid {
max-width: 100%;
}
Suggestions1. Pin zensical in The dependency is unpinned ( 2. Add a comment in The ~30 copies of inline 3. Confirm README link covers contributor needs The new link points to the Zensical docs at a very early release stage. The old MkDocs link was a well-established guide covering frontmatter, navigation, and admonitions. If the Zensical docs don't yet cover those contributor-relevant topics, consider keeping a secondary link to the MkDocs writing guide as a fallback. Minor
🤖 Generated with Claude Code |
The macros plugin enables Jinja2 templating in markdown, which is used in docs/chat_widget/styling.md to render CSS color swatches. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- changelog.md: fix anchor #get-session-state → #get-session-state-key
- participant_data.md: convert reference link with attr_list to inline (zensical doesn't parse [text][ref]{attr})
- add_a_knowledge_base.md, deploy_to_different_channels.md, workflow_cookbook.md: remove unused link reference definitions
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Fail the build on any warnings (broken anchors, unused link refs, etc.) to prevent doc regressions from landing on main. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Zensical resolves docstring link paths relative to the docs/ root, not relative to the .py file. Update the temporary-state, session-state, and http_client cross-references to use the full tech-hub/... prefix so they resolve to the correct rendered pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
@lisa-tarbo FYI I've migrated the docs from mkdocs-material to it's successor: zensical |
Summary
mkdocs gh-deployto GitHub Pages artifact deployment (upload-pages-artifact+deploy-pages)mkdocs-macros-plugindependency (not yet supported by zensical)mkdocstrings[python]to>=1.0.0for zensical compatibilitysite/to.gitignoreBefore merging
Test plan
uv run zensical build --cleansucceeds locallyuv run zensical serverenders the site correctly🤖 Generated with Claude Code