docs: rewrite site on Zensical with runnable examples#70
Merged
Conversation
Replace the MkDocs site with Zensical, reorganize content under docs/pages/, and back every model example with executable scripts in docs/examples/. Codify dual declaration-style tabs and lambda-first query examples in AGENTS.md, CI, and docstrings so docs and library guidance stay aligned. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs site now ships on Zensical instead of MkDocs, with a clearer information architecture and examples that actually run in CI. Readers get side-by-side Assignment and Annotated model declarations, and query examples consistently use lambda predicates — the style we want to standardize on before operator syntax is deprecated.
Key structural changes:
mkdocs.yml)zensical.toml)docs/treedocs/pages/content +docs/examples/scripts_annotatedcompanions, exercised bytests/test_docs_examples.pyAGENTS.md adds invariants I-8 (dual declaration tabs) and I-9 (lambda predicates) so future doc edits stay consistent. Docstrings in
Model.whereandQuery.wherematch the new guidance.Test plan
uv run pytest tests/test_docs_examples.py— 125 passeduv run zensical build— site builds locally