Commit 0eda82f
committed
docs: add Zensical documentation site with versioned deployment
Set up a documentation website using Zensical (the actively maintained
drop-in replacement for MkDocs, by the mkdocs-material team) with
versioned docs deployed to GitHub Pages via squidfunk's mike fork.
- Add zensical.toml with collapsible nav, light/dark toggle, search,
and version switching via mike.
- Add pyproject.toml for uv-managed Python dependencies (zensical,
squidfunk/mike fork). Contributors preview docs with
`uv run zensical serve`.
- Add .github/workflows/docs.yml with two deployment paths: prerelease
docs on push to main, versioned docs on GitHub release publication.
Skipped on forks.
- Split SETUP.md into installation.md (tabbed install options),
editor-setup.md, and agent-setup.md for cleaner navigation.
- Add docs/configuration.md as a dedicated config reference with
complete tables for all config sections.
- Add docs/benchmarks.md with comparison table and links to live
latency and memory charts.
- Add docs/index.md landing page with centered logo, key features,
and version jump links.
- Rename project-specific docs to lowercase (cli.md, configuration.md).
- Fix all 25 broken anchor links in roadmap docs.
- Fix missing 0.9.0 link reference in CHANGELOG.md.
- Add roadmap sub-pages and benchmarks to navigation.
- Add formatting.pint to config-schema.json (was missing from schema).
- Add .github/PULL_REQUEST_TEMPLATE.md with contributor checklist.
- Update DEFAULT_CONFIG_CONTENT with helpful comments and docs link.
- Simplify README.md documentation section to link to docs site.
- Update docs/CONTRIBUTING.md with docs build instructions.
- Add site/ and .venv/ to .gitignore.1 parent 37d6f78 commit 0eda82f
20 files changed
Lines changed: 1102 additions & 460 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
94 | | - | |
95 | | - | |
96 | | - | |
97 | | - | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
| 94 | + | |
102 | 95 | | |
103 | 96 | | |
104 | 97 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
66 | | - | |
| 66 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| |||
824 | 824 | | |
825 | 825 | | |
826 | 826 | | |
827 | | - | |
| 827 | + | |
| 828 | + | |
828 | 829 | | |
829 | 830 | | |
830 | 831 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
48 | 77 | | |
49 | 78 | | |
50 | 79 | | |
51 | 80 | | |
52 | 81 | | |
53 | 82 | | |
54 | | - | |
| 83 | + | |
0 commit comments