docs: initialize mdBook structure with stub pages and deployment workflow #105

forbes · 2026-02-09T14:00:45Z

forbes commented

2026-02-09 14:00:45 +00:00

Set up mdBook documentation scaffolding for auto-deployment to docs.kindred-systems.com.

Issues

Closes #102, closes #103

Changes

mdBook scaffolding:

docs/book.toml — coal theme, repo link, custom CSS
docs/src/SUMMARY.md — sidebar navigation (4 sections, 16 pages)
docs/theme/kindred.css — minimal sidebar width override

16 content pages across docs/src/:

Guide: getting-started, installation, building (pixi task table, submodule table, platform notes), workbenches, ztools (commands, manipulator, structure), silo (14 commands, origin integration, server setup)
Architecture: overview (three-layer model, bootstrap sequence, origin system), python-source-of-truth, silo-server, ondsel-solver
Development: contributing, code-quality, repo-structure, build-system
Reference: configuration (Silo + update checker params), glossary (19 terms, 7 repo URLs)

All pages populated from actual source files where possible.

CI/CD:

.gitea/workflows/docs.yml — builds with mdbook build docs/ and deploys to /opt/git/docs/book/ on push to main (paths: docs/**), runs on docs runner label

Misc:

docs/book/ added to .gitignore

Existing auto-generated docs in docs/*.md are left in place for now — they do not conflict with the mdBook src/ directory.

Set up mdBook documentation scaffolding for auto-deployment to `docs.kindred-systems.com`. ## Issues Closes #102, closes #103 ## Changes **mdBook scaffolding:** - `docs/book.toml` — coal theme, repo link, custom CSS - `docs/src/SUMMARY.md` — sidebar navigation (4 sections, 16 pages) - `docs/theme/kindred.css` — minimal sidebar width override **16 content pages** across `docs/src/`: - **Guide:** getting-started, installation, building (pixi task table, submodule table, platform notes), workbenches, ztools (commands, manipulator, structure), silo (14 commands, origin integration, server setup) - **Architecture:** overview (three-layer model, bootstrap sequence, origin system), python-source-of-truth, silo-server, ondsel-solver - **Development:** contributing, code-quality, repo-structure, build-system - **Reference:** configuration (Silo + update checker params), glossary (19 terms, 7 repo URLs) All pages populated from actual source files where possible. **CI/CD:** - `.gitea/workflows/docs.yml` — builds with `mdbook build docs/` and deploys to `/opt/git/docs/book/` on push to `main` (paths: `docs/**`), runs on `docs` runner label **Misc:** - `docs/book/` added to `.gitignore` Existing auto-generated docs in `docs/*.md` are left in place for now — they do not conflict with the mdBook `src/` directory.

forbes added 1 commit 2026-02-09 14:00:46 +00:00

docs: initialize mdBook structure with stub pages and deployment workflow

Build and Test / build (pull_request) Has been cancelled

Details

64bde8d97a

- Add docs/book.toml with coal theme, repo link, and custom CSS
- Add docs/src/SUMMARY.md with navigation structure
- Create 16 content pages across guide/, architecture/, development/, reference/
- Add docs/theme/kindred.css with minimal sidebar overrides
- Add .gitea/workflows/docs.yml for auto-deploy on push to main
- Add docs/book/ to .gitignore

Pages are populated with real content from the codebase where possible.
Remaining pages have TODO markers for future content.

forbes merged commit 769072fb9d into main

2026-02-09 14:02:59 +00:00

forbes referenced this issue from a commit

2026-02-09 14:02:59 +00:00

Merge pull request 'docs: initialize mdBook structure with stub pages and deployment workflow' (#105) from docs/mdbook-setup into main