## Monorepo `
Monorepo !include pattern for manuscript/master nav¶
Pipeio already has a clean monorepo pattern: docs_collect() → docs_nav() writes docs/pipelines/mkdocs.yml, and _sync_mkdocs_monorepo() inserts !include in root mkdocs.yml.
Task¶
Replicate this pattern for manuscript and master file sections:
manuscript_nav()innotio.manuscript— auto-generatedocs/manuscript/mkdocs.ymlfrom the manuscript registry:- Scan configured manuscript folders (not hardcoded to "manuscript" — any folder with sections + master.md)
- Build nav with sections grouped by manuscript name
- Write standalone mkdocs.yml with
site_name,docs_dir: ., and full nav -
Root mkdocs.yml gets
- Manuscript: '!include ./docs/manuscript/mkdocs.yml' -
Key design point: manuscripts and master files are configurable folder names — a folder with section files and a master.md can be configured as one. The nav generator should discover from config, not assume "manuscript/" or "plan/".
-
Extend
_sync_mkdocs_monorepo()inprojio/sync.pyto handle manuscript includes alongside the existing pipeio include.
Reference¶
- Pipeio pattern:
packages/pipeio/src/pipeio/docs.py:310-385(docs_nav()) - Sync integration:
src/projio/sync.py:310-379(_sync_mkdocs_monorepo()) - Pixecog mkdocs.yml shows current static nav for Manuscript and Plan sections
Related Notes¶
- issue-arash-20260402-121445-694073.md — Directly related: notio manuscript mkdocs transclusion setup is exactly what this issue extends with manuscript_nav() and !include pattern
- issue-arash-20260402-220025-468258.md — Bib architecture doc spec parallels the monorepo nav pattern design work described here
- issue-arash-20260407-050947-246557.md — Pipeio docs_collect/docs_nav pattern referenced in this issue is the model being replicated
- issue-arash-20260402-220100-339672.md — Pipeio modkey change — same pipeio docs.py module where docs_nav() lives (the reference pattern)