rhiza/mkdocs.yml at main · Jebel-Quant/rhiza · GitHub

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
INHERIT: docs/mkdocs-base.yml

site_name: rhiza
site_description: Reusable configuration templates for modern Python projects.
site_url: https://jebel-quant.github.io/rhiza/
repo_url: https://github.com/Jebel-Quant/rhiza
repo_name: Jebel-Quant/rhiza

docs_dir: docs

nav:
  - Home: index.md
  - Getting Started:
    - Quick Reference: guides/QUICK_REFERENCE.md
    - Demo: guides/DEMO.md
    - Book (Docs Site): guides/BOOK.md
    - Extending Rhiza: guides/EXTENDING_RHIZA.md
  - Reference:
    - Architecture: reference/ARCHITECTURE.md
    - Dependencies: reference/DEPENDENCIES.md
    - Tools Reference: reference/TOOLS_REFERENCE.md
    - Shell Scripts: reference/SHELL_SCRIPTS.md
    - Glossary: reference/GLOSSARY.md
  - Development:
    - Tests: development/TESTS.md
    - Docker: development/DOCKER.md
    - Dev Container: development/DEVCONTAINER.md
    - VSCode Extensions: development/VSCODE_EXTENSIONS.md
    - Marimo: development/MARIMO.md
    - Presentation: development/PRESENTATION.md
    - GitHub Agentic Workflows: development/GH_AW.md
  - Operations:
    - Changelog Guide: ops/CHANGELOG_GUIDE.md
    - Project Board: ops/PROJECT_BOARD.md
    - Technical Debt: ops/TECHNICAL_DEBT.md
  - Security:
    - Security Testing: security/SECURITY_TESTING.md
  - Architecture Decision Records:
    - Overview: adr/README.md
    - ADR-0001 Use Architecture Decision Records: adr/0001-use-architecture-decision-records.md
    - ADR-0002 Use uv for Python Package Management: adr/0002-use-uv-for-python-package-management.md
    - ADR-0003 Use Ruff for Linting and Formatting: adr/0003-use-ruff-for-linting-and-formatting.md
    - ADR-0004 Adopt Modular Makefile Architecture: adr/0004-adopt-modular-makefile-architecture.md
    - ADR-0005 Separate Rhiza Template from CLI: adr/0005-separate-rhiza-template-from-cli.md
    - ADR-0006 Organise Templates into Bundles: adr/0006-organise-templates-into-bundles.md
    - ADR-0007 Support Dual CI/CD (GitHub & GitLab): adr/0007-support-dual-cicd-github-and-gitlab.md
    - ADR-0008 Use Marimo for Interactive Notebooks: adr/0008-use-marimo-for-interactive-notebooks.md
    - ADR-0009 Use Pre-commit Hooks for Code Quality: adr/0009-use-pre-commit-hooks-for-code-quality.md
  - Notebooks:
    - Rhiza: notebooks/rhiza.html