docs: include Silo server documentation in mdBook site #122

New Issue

forbes · 2026-02-09T17:38:58Z

forbes commented

2026-02-09 17:38:58 +00:00

Summary

Include the latest Silo server documentation from kindred/silo in the Kindred Create mdBook site at docs.kindred-systems.com. The silo server repo has 12 markdown docs covering auth, configuration, deployment, BOM merge, component audit, and more.

Approach

Add a CI step in docs.yml that clones the silo server repo and copies its docs/ markdown files into docs/src/silo-server/ before mdbook build runs. No submodules or custom preprocessors needed.

Silo Server Docs Available

From kindred/silo/docs/:

SPECIFICATION.md — API specification
CONFIGURATION.md — Server configuration
DEPLOYMENT.md — Deployment guide
AUTH.md — Authentication system
AUTH_MIDDLEWARE.md — Auth middleware internals
AUTH_USER_GUIDE.md — User-facing auth guide
BOM_MERGE.md — BOM merge logic
CALC_EXTENSION.md — Calculated fields extension
COMPONENT_AUDIT.md — Component audit feature
GAP_ANALYSIS.md — Gap analysis
STATUS.md — Status system

Plus README.md, ROADMAP.md, and frontend-spec.md at the repo root.

Implementation Tasks

1. Update `docs.yml` workflow

Add a step before mdbook build that:

- name: Fetch Silo server docs
  run: |
    git clone --depth 1 http://gitea:3000/kindred/silo.git /tmp/silo
    mkdir -p docs/src/silo-server
    cp /tmp/silo/docs/*.md docs/src/silo-server/
    cp /tmp/silo/README.md docs/src/silo-server/overview.md
    rm -rf /tmp/silo

2. Update `SUMMARY.md`

Add a new Silo Server section:

# Silo Server

- [Overview](./silo-server/overview.md)
- [Specification](./silo-server/SPECIFICATION.md)
- [Configuration](./silo-server/CONFIGURATION.md)
- [Deployment](./silo-server/DEPLOYMENT.md)
- [Authentication](./silo-server/AUTH.md)
  - [Middleware](./silo-server/AUTH_MIDDLEWARE.md)
  - [User Guide](./silo-server/AUTH_USER_GUIDE.md)
- [BOM Merge](./silo-server/BOM_MERGE.md)
- [Calculated Fields](./silo-server/CALC_EXTENSION.md)
- [Component Audit](./silo-server/COMPONENT_AUDIT.md)
- [Status System](./silo-server/STATUS.md)

3. Add `docs/src/silo-server/` to `.gitignore`

Since the files are fetched at build time, they shouldn't be committed.

Notes

Uses http://gitea:3000 (Docker network) since the docs runner is in the same Docker network as Gitea
Docs are always pulled from silo's main branch, so they stay current without manual syncing
The existing architecture/silo-server.md stub can be updated to link to the full docs section

## Summary Include the latest Silo server documentation from `kindred/silo` in the Kindred Create mdBook site at `docs.kindred-systems.com`. The silo server repo has 12 markdown docs covering auth, configuration, deployment, BOM merge, component audit, and more. ## Approach Add a CI step in `docs.yml` that clones the silo server repo and copies its `docs/` markdown files into `docs/src/silo-server/` before `mdbook build` runs. No submodules or custom preprocessors needed. ## Silo Server Docs Available From `kindred/silo/docs/`: - `SPECIFICATION.md` — API specification - `CONFIGURATION.md` — Server configuration - `DEPLOYMENT.md` — Deployment guide - `AUTH.md` — Authentication system - `AUTH_MIDDLEWARE.md` — Auth middleware internals - `AUTH_USER_GUIDE.md` — User-facing auth guide - `BOM_MERGE.md` — BOM merge logic - `CALC_EXTENSION.md` — Calculated fields extension - `COMPONENT_AUDIT.md` — Component audit feature - `GAP_ANALYSIS.md` — Gap analysis - `STATUS.md` — Status system Plus `README.md`, `ROADMAP.md`, and `frontend-spec.md` at the repo root. ## Implementation Tasks ### 1. Update `docs.yml` workflow Add a step before `mdbook build` that: ```yaml - name: Fetch Silo server docs run: | git clone --depth 1 http://gitea:3000/kindred/silo.git /tmp/silo mkdir -p docs/src/silo-server cp /tmp/silo/docs/*.md docs/src/silo-server/ cp /tmp/silo/README.md docs/src/silo-server/overview.md rm -rf /tmp/silo ``` ### 2. Update `SUMMARY.md` Add a new `Silo Server` section: ```markdown # Silo Server - [Overview](./silo-server/overview.md) - [Specification](./silo-server/SPECIFICATION.md) - [Configuration](./silo-server/CONFIGURATION.md) - [Deployment](./silo-server/DEPLOYMENT.md) - [Authentication](./silo-server/AUTH.md) - [Middleware](./silo-server/AUTH_MIDDLEWARE.md) - [User Guide](./silo-server/AUTH_USER_GUIDE.md) - [BOM Merge](./silo-server/BOM_MERGE.md) - [Calculated Fields](./silo-server/CALC_EXTENSION.md) - [Component Audit](./silo-server/COMPONENT_AUDIT.md) - [Status System](./silo-server/STATUS.md) ``` ### 3. Add `docs/src/silo-server/` to `.gitignore` Since the files are fetched at build time, they shouldn't be committed. ## Notes - Uses `http://gitea:3000` (Docker network) since the docs runner is in the same Docker network as Gitea - Docs are always pulled from silo's `main` branch, so they stay current without manual syncing - The existing `architecture/silo-server.md` stub can be updated to link to the full docs section

forbes added the documentation label 2026-02-09 17:38:58 +00:00

forbes referenced this issue from a commit

2026-02-09 18:37:53 +00:00

docs: add Silo server documentation with auto-sync workflow (#122)

forbes referenced a pull request that will close this issue

2026-02-09 18:38:03 +00:00

docs: add Silo server documentation with auto-sync workflow (#122) #123

forbes referenced this issue from a commit

2026-02-09 18:39:04 +00:00

Merge pull request 'docs: add Silo server documentation with auto-sync workflow (#122)' (#123) from docs/sync-silo-server-docs into main

forbes closed this issue

2026-02-09 18:39:04 +00:00