Skip to content

Documentation Content Map

This file defines the documentation production plan for Leci and makes content sourcing explicit. It exists to prevent undocumented assumptions and to keep docs tied to code, roadmap, and owner inputs.

  • P0 means mandatory content for shipping a usable docs site.
  • P1 means important content for maintainability and stakeholder confidence.
  • P2 means deferred content that can be published after core documentation stabilizes.
FilePlanned content focusSource of truthPriority
docs/index.mdAudience-oriented entry point and navigation strategy.docs/architecture/PROJECT_MAP.md, docs/planning/ROADMAP.md, owner inputP0
docs/getting-started/introduction.mdProduct purpose, scope boundaries, and positioning.PROJECT_MAP, ROADMAP, owner inputP0
docs/getting-started/quickstart.mdMinimum working setup path and baseline checks.scripts, .env.example, README.mdP0
docs/getting-started/installation.mdFull reproducible installation and validation workflows.configs, PROJECT_MAP, owner inputP0
docs/architecture/overview.mdCurrent and target architecture with boundaries and flow.PROJECT_MAP, ROADMAP, PREMORTEMP0
docs/architecture/stack.mdVersions, responsibilities, and update policy for stack components.package.json, lockfile, configsP0
docs/architecture/decisions.mdActive and pending architectural decisions and ADR workflow.ROADMAP, PREMORTEM, owner inputP1
docs/architecture/diagrams.mdMermaid diagrams for system, data model, and workflows.PROJECT_MAP, schema/migrations, roadmapP1
docs/features/index.mdFeature catalog with implementation status and milestone mapping.ROADMAP, PROJECT_MAP, owner inputP0
docs/features/core-data-model-and-migrations.mdSchema and migration behavior as a product capability.src/db/schema.ts, drizzle/0001_init.sql, scripts/migrate.tsP0
docs/features/legal-search-foundation.mdFTS/vector foundations and planned API search behavior.schema and roadmapP0
docs/features/revision-and-audit-trail.mdEdit governance and revision audit integrity.SQL function, AGENTS.md, roadmapP0
docs/features/web-interface.mdCurrent UI state and planned user journeys.src/app/*, roadmapP1
docs/features/data-ingestion-pipeline.mdPlanned ingestion lifecycle and reliability model.roadmap, premortem, owner inputP1
docs/features/temporal-trust-layer.mdInnovation proposal for temporal legal trustability.INNOVATION_LAYER, PREMORTEM, owner inputP2
docs/configuration/environment.mdEnvironment variable reference and handling rules..env.example, scripts/workflowsP0
docs/configuration/settings.mdProject config file reference and governance policy.runtime/build configsP1
docs/configuration/integrations.mdExternal service setup and reliability constraints.workflows, roadmap, owner inputP1
docs/development/setup.mdContributor setup and daily operation workflow.commands, conventions, roadmap mitigationsP0
docs/development/conventions.mdNaming, typing, and integrity conventions.AGENTS.md, code patternsP0
docs/development/testing.mdCurrent test baseline and quality-gate evolution path.scripts, roadmap, premortemP0
docs/development/contributing.mdEnd-to-end contribution process and review checklist.repo workflow and conventionsP1
docs/roadmap/index.mdStrategic roadmap context and governance model.planning roadmap artifactP1
docs/roadmap/milestones.mdMilestone-level scopes, dependencies, and exit criteria.planning roadmap artifactP1
docs/roadmap/changelog.mdTrace of roadmap changes and planning decisions.planning governance processP2
docs/reference/glossary.mdShared legal and technical vocabulary.schema terminology, owner inputP1
docs/reference/faq.mdRecurring setup/product/integration questions.all docs and support patternsP2
docs/reference/troubleshooting.mdOperational troubleshooting for common failure modes.scripts, setup docs, CI behaviorP1

Supporting source artifacts kept in this repository

Section titled “Supporting source artifacts kept in this repository”
FileRole in documentation pipeline
docs/architecture/PROJECT_MAP.mdBaseline technical diagnosis snapshot used for evidence-based writing.
docs/planning/ROADMAP.mdMaster planning input for status labels and milestone pages.
docs/planning/PREMORTEM.mdRisk input source for mitigations and sequencing guidance.
docs/planning/INNOVATION_LAYER.mdStrategic innovation candidate input.
docs/planning/REORG_PLAN.mdRepository structure and documentation governance plan.
docs/README.mdInternal docs-folder orientation page.
docs/adr/README.mdADR folder usage and format reference.

Authoring notes for subsequent documentation phases

Section titled “Authoring notes for subsequent documentation phases”
  • Fill P0 pages first when publishing to a new environment.
  • Label planned behavior explicitly and avoid presenting roadmap items as implemented.
  • Keep human readability and AI-agent parseability balanced in every section.