This commit is contained in:
John Lancaster
2026-06-18 22:34:31 -05:00
parent a4db33531e
commit 1254cc5432
5 changed files with 149 additions and 1 deletions
@@ -2,6 +2,13 @@
Use this reference when deciding which Zensical features to enable and why.
## Project Bootstrap
Always start a new docs project with `uv run zensical new`.
- It creates the baseline scaffolding for configuration, docs structure, and theme integration.
- Treat this as the default starting point rather than manually assembling files.
## High-Value Feature Groups
### Navigation and Discoverability
@@ -22,9 +29,12 @@ Source links:
- `content.code.copy`: copy button in code blocks.
- `content.code.select`: line range selection support.
- `content.code.annotate`: inline code annotations.
- Prefer mkdocstrings for generated API reference pages when documenting Python code.
- Keep generated API pages linked from hand-authored task and concept docs.
Source links:
- https://zensical.org/docs/authoring/code-blocks/
- https://mkdocstrings.github.io/
### Cross-Page UX Consistency
@@ -63,6 +73,6 @@ Source links:
## Practical Feature Selection Rules
1. Start with discoverability and clarity features first.
2. Add convenience features (copy/select/tooltips) when content type supports them.
2. For code-heavy docs, add copy/select/annotate first, then define mkdocstrings coverage for API reference.
3. Avoid enabling many features at once without measurement.
4. Track user success metrics (search success, time-to-answer, support deflection) after each change.