@ngockhoale/ukit 2.6.5 → 2.6.7

package/manifests/documentation.yaml

@@ -0,0 +1,662 @@
+version: 1
+generated: false
+description: >-
+  Machine-readable ownership/source registry for every documentation surface.
+  Hand-authored per SPEC §7; enforced by tests/consistency/docRegistry.test.js.
+entries:
+  # ── Repo root ────────────────────────────────────────────────────────────
+  - id: root-claude-md
+    path: CLAUDE.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: CLAUDE.md
+    merge_strategy: skip
+    load_policy: always
+    validation: [manual]
+    archive_policy: never
+    notes: generated by yarn docs:render from templates/instructions/ + repo overlay
+  - id: root-agents-md
+    path: AGENTS.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: AGENTS.md
+    merge_strategy: skip
+    load_policy: always
+    validation: [manual]
+    archive_policy: never
+    notes: generated by yarn docs:render from templates/instructions/ + repo overlay
+  - id: root-readme
+    path: README.md
+    class: canonical
+    audience: [user, maintainer, contributor]
+    owner: product
+    source_of_truth: README.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual, test:tests/consistency/rootReadme.test.js]
+    archive_policy: never
+    notes: user-first refactor shipped DOC-107 (2026-09-19)
+  - id: root-quick-start
+    path: QUICK_START.md
+    class: canonical
+    audience: [user, maintainer]
+    owner: product
+    source_of_truth: QUICK_START.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: maintainer-authored quick start
+  - id: root-project-important
+    path: PROJECT_IMPORTANT.md
+    class: owner
+    audience: [owner, agent]
+    owner: project-owner
+    source_of_truth: PROJECT_IMPORTANT.md
+    merge_strategy: skip
+    load_policy: always
+    validation: [manual]
+    archive_policy: owner-decides
+    notes: user-authored owner file living in this repo; installed target of manifest `project-important`
+  - id: root-changelog
+    path: CHANGELOG.md
+    class: canonical
+    audience: [maintainer, user]
+    owner: release
+    source_of_truth: CHANGELOG.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: release record
+  - id: registry-self
+    path: manifests/documentation.yaml
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: manifests/documentation.yaml
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [test:tests/consistency/docRegistry.test.js]
+    archive_policy: never
+    notes: self-describing entry
+
+  # ── docs/ canonical files ────────────────────────────────────────────────
+  - id: docs-bugfix
+    path: docs/BUGFIX.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/BUGFIX.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-bug-index
+    path: docs/BUG_INDEX.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/BUG_INDEX.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-bug-metrics
+    path: docs/BUG_METRICS.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/BUG_METRICS.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-bug-template
+    path: docs/BUG_TEMPLATE.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/BUG_TEMPLATE.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-code-map
+    path: docs/CODE_MAP.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/CODE_MAP.md
+    merge_strategy: none
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    budget: { max_lines: 250, enforcement: warning }
+  - id: docs-improvement-roadmap
+    path: docs/DOCUMENTATION_IMPROVEMENT_ROADMAP.md
+    class: canonical
+    audience: [maintainer]
+    owner: product
+    source_of_truth: docs/DOCUMENTATION_IMPROVEMENT_ROADMAP.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-gateway
+    path: docs/GATEWAY.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: docs/GATEWAY.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-install
+    path: docs/INSTALL.md
+    class: canonical
+    audience: [user, maintainer]
+    owner: product
+    source_of_truth: docs/INSTALL.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-memory
+    path: docs/MEMORY.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/MEMORY.md
+    merge_strategy: none
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    budget: { max_lines: 200, enforcement: warning }
+  - id: docs-project
+    path: docs/PROJECT.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/PROJECT.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-project-important-spec
+    path: docs/PROJECT_IMPORTANT_SPEC.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/PROJECT_IMPORTANT_SPEC.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: replace-with-snapshot
+    notes: archived DOC-106 → docs/archive/specs/; live file is compact decision record
+  - id: docs-context-budget
+    path: docs/CONTEXT_BUDGET.md
+    class: canonical
+    audience: [maintainer]
+    owner: product
+    source_of_truth: docs/CONTEXT_BUDGET.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: moved from README.md DOC-107
+  - id: docs-prompt-caching
+    path: docs/PROMPT_CACHING.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/PROMPT_CACHING.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-release-checklist
+    path: docs/RELEASE_CHECKLIST.md
+    class: canonical
+    audience: [maintainer]
+    owner: release
+    source_of_truth: docs/RELEASE_CHECKLIST.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-ukit-codev-principles
+    path: docs/UKIT_CODEV_PRINCIPLES.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/UKIT_CODEV_PRINCIPLES.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-ukit-usage-guide
+    path: docs/UKIT_USAGE_GUIDE.md
+    class: canonical
+    audience: [user, maintainer]
+    owner: product
+    source_of_truth: docs/UKIT_USAGE_GUIDE.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: docs-worklog-archive
+    path: docs/WORKLOG_ARCHIVE.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: docs/WORKLOG_ARCHIVE.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+
+  # ── docs/ runtime + dir families ─────────────────────────────────────────
+  - id: docs-status
+    path: docs/STATUS.md
+    class: runtime
+    audience: [agent, maintainer]
+    owner: runtime
+    source_of_truth: docs/STATUS.md
+    merge_strategy: none
+    load_policy: continuation-only
+    validation: [manual]
+    archive_policy: date-rotate
+    budget: { max_lines: 150, enforcement: error }
+    notes: enforcement flipped to error by TASK-005 (2026-09-19)
+  - id: docs-worklog
+    path: docs/WORKLOG.md
+    class: runtime
+    audience: [agent, maintainer]
+    owner: runtime
+    source_of_truth: docs/WORKLOG.md
+    merge_strategy: none
+    load_policy: continuation-only
+    validation: [manual]
+    archive_policy: never
+    budget: { max_lines: 600, enforcement: warning }
+    notes: rotation = DOC-105
+  - id: docs-ai-handoff
+    path: docs/AI_HANDOFF/
+    class: runtime
+    audience: [agent, maintainer]
+    owner: runtime
+    source_of_truth: docs/AI_HANDOFF/
+    merge_strategy: none
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    notes: dir entry — covers all files beneath
+  - id: docs-archive
+    path: docs/archive/
+    class: archive
+    audience: [maintainer]
+    owner: product
+    source_of_truth: docs/archive/
+    merge_strategy: none
+    load_policy: never
+    validation: [none]
+    archive_policy: immutable
+    notes: covers docs/archive/releases/ — no separate row
+  - id: docs-baseline
+    path: docs/_baseline/
+    class: archive
+    audience: [maintainer]
+    owner: product
+    source_of_truth: docs/_baseline/
+    merge_strategy: none
+    load_policy: never
+    validation: [none]
+    archive_policy: immutable
+  - id: docs-plans
+    path: docs/plans/
+    class: archive
+    audience: [maintainer]
+    owner: product
+    source_of_truth: docs/plans/
+    merge_strategy: none
+    load_policy: never
+    validation: [none]
+    archive_policy: immutable
+  - id: docs-research
+    path: docs/research/
+    class: archive
+    audience: [maintainer]
+    owner: product
+    source_of_truth: docs/research/
+    merge_strategy: none
+    load_policy: never
+    validation: [none]
+    archive_policy: immutable
+
+  # ── templates/ canonical authoring sources ───────────────────────────────
+  - id: tpl-claude-md
+    path: templates/CLAUDE.md
+    class: generated
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/instructions/
+    merge_strategy: overwrite_with_backup
+    load_policy: always
+    validation: [manual, test:tests/consistency/instructionRender.test.js]
+    archive_policy: never
+    notes: generated by yarn docs:render from templates/instructions/ (DOC-102); renders to installed roots
+  - id: tpl-agents-md
+    path: templates/AGENTS.md
+    class: generated
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/instructions/
+    merge_strategy: overwrite_with_backup
+    load_policy: always
+    validation: [manual, test:tests/consistency/instructionRender.test.js]
+    archive_policy: never
+    notes: generated by yarn docs:render from templates/instructions/ (DOC-102); renders to installed roots
+  - id: tpl-instructions
+    path: templates/instructions/
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/instructions/
+    merge_strategy: none
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    notes: dir entry — core/overlay render sources (DOC-102)
+  - id: tpl-instructions-core
+    path: templates/instructions/core.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/instructions/core.md
+    merge_strategy: none
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    budget: { max_lines: 160, enforcement: warning }
+    notes: canonical shared core; pre-shrink >160 is warning-only (DOC-104 shrinks)
+  - id: tpl-omp-rules
+    path: templates/.omp/RULES.md
+    class: generated
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: templates/instructions/overlays/omp-rules.md
+    merge_strategy: overwrite_with_backup
+    load_policy: always
+    validation: [manual, test:tests/consistency/ompContextLayer.test.js]
+    archive_policy: never
+    notes: generated by yarn docs:render from overlay:omp-rules (DOC-102); file entry overrides tpl-omp-dir
+  - id: tpl-project-important
+    path: templates/PROJECT_IMPORTANT.md
+    class: canonical
+    audience: [owner, agent, maintainer]
+    owner: project-owner
+    source_of_truth: templates/PROJECT_IMPORTANT.md
+    merge_strategy: skip
+    load_policy: always
+    validation: [manual]
+    archive_policy: never
+    notes: seeds owner file
+  - id: tpl-docs-dir
+    path: templates/docs/
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/
+    merge_strategy: overwrite_with_backup
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: default for docs templates; skip items have per-file entries below
+  - id: tpl-docs-project
+    path: templates/docs/PROJECT.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/PROJECT.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-memory
+    path: templates/docs/MEMORY.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/MEMORY.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-worklog
+    path: templates/docs/WORKLOG.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/WORKLOG.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-code-map
+    path: templates/docs/CODE_MAP.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/CODE_MAP.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-bugfix
+    path: templates/docs/BUGFIX.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/BUGFIX.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-bug-template
+    path: templates/docs/BUG_TEMPLATE.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/BUG_TEMPLATE.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-bug-index
+    path: templates/docs/BUG_INDEX.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/BUG_INDEX.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-bug-metrics
+    path: templates/docs/BUG_METRICS.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/BUG_METRICS.md
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: tpl-docs-ai-handoff
+    path: templates/docs/AI_HANDOFF/
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/AI_HANDOFF/
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: dir sourceTemplate docs/AI_HANDOFF → dir path ending '/'
+  - id: tpl-docs-ukit-internals
+    path: templates/docs/UKIT_INTERNALS.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: product
+    source_of_truth: templates/docs/UKIT_INTERNALS.md
+    merge_strategy: overwrite_with_backup
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    notes: internal-orchestration detail extracted from core.md (DOC-104); shipped via docs-ukit-internals manifest item
+  - id: tpl-codex-readme
+    path: templates/.codex/README.md
+    class: canonical
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: templates/.codex/README.md
+    merge_strategy: overwrite_with_backup
+    load_policy: always
+    validation: [manual]
+    archive_policy: never
+    notes: codex host adapter surface — FR-007 scan
+  - id: tpl-omp-dir
+    path: templates/.omp/
+    class: canonical
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: templates/.omp/
+    merge_strategy: overwrite_with_backup
+    load_policy: always
+    validation: [manual]
+    archive_policy: never
+    notes: omp host adapter surface (AGENTS/README/RULES + agents)
+  - id: tpl-ukit-readme
+    path: templates/ukit/README.md
+    class: canonical
+    audience: [maintainer]
+    owner: runtime
+    source_of_truth: templates/ukit/README.md
+    merge_strategy: overwrite_with_backup
+    load_policy: never
+    validation: [manual]
+    archive_policy: never
+    notes: reference only — FR-007 scan
+  - id: tpl-ukit-storage-memory
+    path: templates/ukit/storage/memory/
+    class: canonical
+    audience: [agent, maintainer]
+    owner: runtime
+    source_of_truth: templates/ukit/storage/memory/
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: dir sourceTemplate ukit/storage/memory → dir path ending '/'
+  - id: tpl-claude-dir
+    path: templates/.claude/
+    class: canonical
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: templates/.claude/
+    merge_strategy: overwrite_with_backup
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    notes: skills/agents/hooks dir entry
+  - id: tpl-adapter-presets
+    path: templates/adapter-presets/
+    class: canonical
+    audience: [maintainer]
+    owner: adapter
+    source_of_truth: templates/adapter-presets/
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: mixed strategies per manifest; skip items have per-file entries
+  - id: tpl-preset-claude-settings-local
+    path: templates/adapter-presets/claude/settings.local.json
+    class: canonical
+    audience: [maintainer]
+    owner: adapter
+    source_of_truth: templates/adapter-presets/claude/settings.local.json
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: non-.md entry — exists for FR-002 manifest consistency
+  - id: tpl-preset-codex-settings-local
+    path: templates/adapter-presets/codex/settings.local.json
+    class: canonical
+    audience: [maintainer]
+    owner: adapter
+    source_of_truth: templates/adapter-presets/codex/settings.local.json
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: non-.md entry — exists for FR-002 manifest consistency
+  - id: tpl-gitignore
+    path: templates/.gitignore
+    class: canonical
+    audience: [maintainer]
+    owner: product
+    source_of_truth: templates/.gitignore
+    merge_strategy: skip
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+    notes: non-.md entry — exists for FR-002 manifest consistency
+
+  # ── repo mirrors (derived from templates/) ───────────────────────────────
+  - id: mirror-claude-dir
+    path: .claude/
+    class: derived
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: templates/.claude/
+    merge_strategy: none
+    load_policy: task-routed
+    validation: [manual]
+    archive_policy: never
+    notes: repo mirror of templates/.claude/
+  - id: mirror-codex-readme
+    path: .codex/README.md
+    class: derived
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: templates/.codex/README.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: mirror-omp-dir
+    path: .omp/
+    class: derived
+    audience: [agent, maintainer]
+    owner: adapter
+    source_of_truth: templates/.omp/
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never
+  - id: mirror-ukit-readme
+    path: .ukit/README.md
+    class: derived
+    audience: [agent, maintainer]
+    owner: runtime
+    source_of_truth: templates/ukit/README.md
+    merge_strategy: none
+    load_policy: on-demand
+    validation: [manual]
+    archive_policy: never