Skip to content

README.md

Latest commit

 

History

History
53 lines (33 loc) · 5.07 KB

README.md

File metadata and controls

53 lines (33 loc) · 5.07 KB
Raw

{{name}}

This is a coding-agent-first AutoMovie production repository. Author production facts, construction and final screenplay documents, source, assets, and delivery indexes as ordinary tracked files. Production execution consumes typed source directly.

Authoring routes

AGENTS.md is the shared coding-agent entry point. It routes contract lookup through the contract skill, production work through production lifecycle, graph changes through evidence graph, implementation through source authoring, and observation or completion through review verification. Read the current production selection and claims from lint.config.ts and their actual owners from docs; the entry point is not a generated facts inventory.

Use Production kinds before selecting kind in lint.config.ts. Use Production documents for physical document ownership, Contract targets for shared and language target forms, Production-specific contract for local discovery results, and Evidence staging before changing a branch stage or evidence annotation. Those routes own their semantics; this README only makes them reachable.

Static-document updates

Scaffold installation is one-way. After creation, AGENTS.md, CLAUDE.md, .agents/skills, contracts, READMEs, configuration, and source are project-owned tracked files. The coding agent maintains them through ordinary reviewed edits and commits; package upgrades do not regenerate or overwrite them. Adopt an upstream instruction or contract change only as an explicit project change, preserving authored content and reconciling its affected callers, claims, and reviews.

Use ordinary coding-agent tools for authoring. Scaffold creation does not register an MCP client or write client configuration.

First run

npm install --package-lock=false
npm run lint
npm run evidence

The blank scaffold is intentionally incomplete. Select the production kind through the routed lifecycle procedure, author its prerequisites, then use the commands below at the stages their linked procedures name.

Canonical command routes

Use the commands declared in package.json:

Command Purpose
npm run lint Check the complete TypeScript program with source correctness lint.
npm run evidence Check the sole production declaration through the standalone graph CLI and source todo guard.
npm run format Format source with the configured compiler formatter.

The scaffold provides instructions, contracts, and source lint, not prewritten production or viewer code. Author only the concrete source the requested work needs through the packages' public APIs. It supplies no film build, capture, render, or publication command.

The installed automovie CLI separately provides Markdown TOC maintenance, external-asset inspection, and capability routes. Read its local help before invoking a command. These operations do not authorize a project state store.

Visual work

When the task needs a model view, building walkthrough, or film playback, follow Live viewing to implement the required view over the production's own source. A page and its controls are authored for that need, not selected from seeded viewer templates.

Ownership

  • All source code belongs under src, including command entry points, viewer code, review declarations, and any test source. Root TypeScript configuration is limited to the production declaration lint.config.ts and the compiler settings source.lint.config.ts and evidence.guard.config.ts. The standalone evidence CLI and production resolver both read the sole production declaration. Source location does not make tooling a production design owner; the typed evidence declaration selects the authored populations.
  • public holds HTML and static assets. Keep executable code in imported src modules rather than inline HTML scripts or asset directories.
  • docs holds authored decisions, contracts, and review observations. Git holds change history. Neither is replaced by a generated state ledger.
  • package.json owns package and source-compiler settings. tsconfig.evidence.json only selects the independent source-guard check over that same program; do not create another JSON configuration, design store, registry, migration journal, receipt, or cache file in the project.
  • Execute production and measurement functions over typed values. Images, media, and reader-facing documents are outputs; serialized project state is not an authoring product.

Run the applicable Author process Self-Review before handing off a completed authoring, evidence, review, or stage-transition boundary.