Skip to content

Core And State Docs

Use docs/core for durable "what the system is" docs, and docs/state for current operational maps that help implementation work start quickly.

This page explains the local docs structure. Product-level planning, repository coordination, and shared process guidance live in the Engineering Handbook section of anuva-main-video-creator.

flowchart TD
  Request["Implementation work"] --> Bootstrap["docs/bootstrap"]
  Request --> Core["docs/core"]
  Request --> State["docs/state"]
  Request --> Process["docs/process"]
  Request --> Changes["docs/changes"]

  Core --> Durable["Durable behavior"]
  State --> Operational["Current paths and commands"]
  Process --> Workflow["Local change workflow"]
  Changes --> History["Change-specific reasoning"]

Core Docs

docs/core describes durable Web/CMS system behavior:

  • ProductModel.md
  • SystemArchitecture.md
  • PresentationVideoWorkflow.md
  • PresentationConfig.md
  • MastraAgentsAndTools.md
  • RagAndSources.md
  • PayloadDataModel.md
  • AuthAndWorkspace.md
  • BillingAndEntitlements.md
  • WorkersAndJobs.md
  • TestingAndVerification.md

Update core docs when implementation changes durable behavior, contracts, data model semantics, auth/workspace behavior, billing behavior, generation flow, or worker/API responsibilities.

State Docs

docs/state describes the current implementation map:

  • CurrentImplementationMap.md
  • RouteMap.md
  • ServerActionsMap.md
  • WorkflowMap.md
  • CollectionMap.md
  • EnvAndServices.md
  • ScriptsAndCommands.md
  • KnownGaps.md
  • RecentDecisions.md
  • DocsUpdateChecklist.md

Update state docs when implementation locations, commands, routes, collections, workflow entry points, current gaps, environment assumptions, or recent decisions change.

Bootstrap, Process, And Changes

  • docs/bootstrap/BootstrapContext.md gives Codex and maintainers a product-aware starting point for this repository.
  • docs/process/ChangeWorkflow.md defines the local Codex-first implementation workflow.
  • docs/changes/<change-folder> preserves large-change reasoning, implementation plans, logs, docs impact, and verification evidence.

Usage Rule

For every implementation change:

  • update docs/core if durable system behavior changed
  • update docs/state if implementation location, commands, gaps, or operational flow changed
  • update docs/changes/<change> when using the large-change workflow
  • report product-main sync needs through the issue, PR completion report, or product-main progress docs when product behavior or cross-repository contracts are affected