.. _docs-system-reference-repo-registry: ###################################################################### Repository Registry ###################################################################### Single source of truth for every repo in the Documentation System --- every Tier 1 standalone doc repo and every Tier 2 aggregation hub. Each entry declares the repo's canonical project slug (which is the label prefix for every cross-reference target the repo publishes), its git path, where its ``conf.py`` lives, its published URL, and its current maturity status. .. note:: **Authoritative source:** ``~/.local/share/docs-system/repos.conf``. The machine-readable ``repos.conf`` file is the single source of truth. The tables on this page are currently hand-transcribed from that file. A Phase 3 tooling item will auto-render these tables from ``repos.conf`` at Sphinx build time. Until that ships, when you add or change a repo, update ``repos.conf`` first and then mirror the change here in the same commit. ********************************************************************** Tier 1 --- Standalone Repos ********************************************************************** .. _docs-system-reference-repo-registry-tier-1: Each Tier 1 repo is its own Sphinx site, served by a dedicated container in ``~/docker/local-websites/docker-compose.yml`` and cross-linked to the others via ``sphinx.ext.intersphinx``. .. list-table:: :header-rows: 1 :widths: 18 13 22 13 20 7 17 * - Repo - Slug - Git Path - ``conf.py`` - Published URL - Status - Notes * - Documentation_System - ``docs-system`` - ``~/Writings/Documentation_System`` - ``source/`` - `docs-system `_ (`inv `_) - healthy - Canonical methodology spec; Phase 1 buildout in progress. * - Linux - ``linux-docs`` - ``~/Writings/Linux`` - root - `linux-docs `_ (`inv `_) - healthy - 41 sections; only repo with a pre-existing CLAUDE.md. * - DevOps-Docs - ``devops-docs`` - ``~/Writings/DevOps-Docs`` - ``source/`` - `devops-docs `_ (`inv `_) - healthy - Includes Project-Doc-Automation section. * - Artificial-Intelligence - ``ai-docs`` - ``~/Writings/Artificial-Intelligence`` - ``source/`` - `ai-docs `_ (`inv `_) - healthy - Active but early; WIP notice on index. * - Server_Programs - ``server-programs`` - ``~/DevOps-Personal/Server_Programs`` - root - `server-programs `_ (`inv `_) - healthy - 89 documented programs; largest Tier 1 content body. * - Accounting - ``accounting-docs`` - ``~/Writings/Accounting`` - ``source/`` - (not yet deployed) - stub - Awaiting content; Phase 5 backlog ingestion will populate. * - Entrepreneurship - ``entrepreneurship-docs`` - ``~/Writings/Entrepreneurship`` - ``source/`` - (not yet deployed) - stub - Awaiting content; Phase 5 backlog ingestion will populate. ********************************************************************** Tier 2 --- Aggregation Hubs ********************************************************************** .. _docs-system-reference-repo-registry-tier-2: A Tier 2 hub is a Sphinx site that mounts other projects' ``docs/`` directories via Docker volumes and builds a unified index across them. Hubs have their own slug and label namespace but their content is sourced from the mounted projects. .. list-table:: :header-rows: 1 :widths: 22 15 25 10 20 8 * - Hub - Slug - Git Path - ``conf.py`` - Published URL - Status * - docker-infrastructure-docs - ``docker-infra-docs`` - ``~/docker/local-websites/docker-infrastructure-docs`` - ``source/`` - `docker-infrastructure `_ (`inv `_) - healthy ********************************************************************** Adding, Renaming, or Retiring a Repo ********************************************************************** .. _docs-system-reference-repo-registry-changes: All three operations touch the same two files: ``repos.conf`` (the authoritative source) and this page (the rendered mirror). Until the Phase 3 auto-render lands, update both in the same commit. - **Add a repo.** Append a line to the correct tier block in ``repos.conf``, then add a matching row to the corresponding table on this page. Full end-to-end scaffold instructions for a new Tier 1 repo (including ``conf.py``, intersphinx wiring, router entry, and the first deploy) live in ``workflows/new-repo.rst`` (forthcoming). - **Rename a slug.** Renames cascade across every label in the repo plus every ``:ref:`` caller in every other repo. Do not attempt without the workflow at ``workflows/label-migration.rst`` (forthcoming). - **Retire a repo.** Move the line from its tier block down to a ``# --- Retired ---`` block at the bottom of ``repos.conf``, change status to ``retired``, and strike the row from this page. ********************************************************************** Planned Repos ********************************************************************** .. _docs-system-reference-repo-registry-planned: This registry tracks only repos that exist on disk today. Planned- but-not-yet-created repos are not listed here; they appear as worked examples in ``workflows/new-repo.rst`` (forthcoming) and move into this registry only once they are scaffolded and serving.