Skip to content

## Configurable docs paths for subsystem-owned documentation Currently, projio

Configurable docs paths for subsystem-owned documentation

Currently, projio subsystems place their interactible docs in hardcoded paths that don't transparently reflect which subsystem owns them:

  • docs/pipelines/ → pipeio
  • docs/log/ → notio

These should be: 1. Configurable in .projio/config.yml with sensible defaults and/or profiles 2. More transparent in naming, e.g.: - docs/pipeio/ (pipelines, flows, modules, rules) - docs/notio/ (notes, log, manuscripts?) - docs/biblio/ (literature, bibliography reports?) - docs/codio/ (library catalog, code intelligence?) - docs/figio/ (figure specs, build outputs?)

Design considerations

  • Defaults should work out of the box (zero-config)
  • Config keys under e.g. docs.paths.<subsystem> allow overrides
  • Profiles could bundle path conventions (e.g. docs.profile: transparent vs docs.profile: semantic)
  • Migration path needed for existing projects with current layout
  • MkDocs nav generation (pipeio_mkdocs_nav_patch, pipeio_docs_nav) must respect configured paths
  • projio sync should wire up the configured paths

Open questions

  • Should manuscripts live under docs/notio/ or get their own top-level docs/manuscripts/?
  • What other subsystems have docs that need path configuration?
  • Should the config support arbitrary additional doc roots beyond the six subsystems?

Future version — not urgent, but worth designing properly.