modules/

Purpose

Per-module documentation. One subfolder per module; everything for that module lives together.

Structure

Each module gets docs/modules// containing (per the pipeline in /process):

  • schema.md — the module's tables and what each is used for
  • knowledge.md — what the module handles, in plain language, including how its AI features behave ON and OFF
  • ai-mapping.md — this module's AI features mapped to the AI Capability Plane (capability, authority level, OFF behavior, governance controls)
  • service-contract.md — the public API other modules call

Rules

  • A module subfolder is created when the module enters design.
  • A module is not "design-locked" or "shipped" until it passes the matching gate checklist in /process.
  • Do NOT list which modules exist or their status here — that lives in /index.

What does NOT belong here

  • System-wide architecture → architecture/.
  • The pipeline/gates → process/.
  • Cross-cutting AI plane → ai/.

Source of truth

Live status/counts → /index.

On this page
Esc