Files
hypit/docs

Documentation

Use the shortest path that matches what you are trying to do. The author guides explain the product; the developer guides explain extension points; architecture and specifications define implementation boundaries.

Make a video

  1. ../README.md — understand Narratage and run the first provider-free commands.
  2. quickstart.md — install the checkout, compile a complete video graph and set up a project outside the repository.
  3. quickstart/script.md through quickstart/composition.md — author Script, style, generation, timing, Tracks, Film and rendering.
  4. quickstart/run.md — choose Targets, configure the Runtime, build, inspect, reuse and retrieve results.

The website publishes these pages at narratage.hypit.ai.

Extend Narratage

  1. guide/develop.md — repository setup and guide index.
  2. guide/packages.md — package layers, facets and dependency rules.
  3. guide/author-packages.md — add author vocabulary and graph lowering.
  4. guide/providers.md — implement an external capability endpoint.
  5. guide/runtime-profile.md — assemble Schedulers, Stores and Providers.

Understand the system

  1. architecture.md — current Author Graph, Run Graph, Satisfaction, Runtime and package boundaries.
  2. ../spec/core-kernel.md — compact normative Kernel laws for the current @1 wire data.
  3. implementation-status.md — what actually executes today.
  4. roadmap.md — remaining domain-neutral, environment and video-package work.
  5. open-source-distribution.md — packaging facts and release gates.

Domain-neutral implementation records

  • graph-first-value-boundary.md — graph edges own dependency truth; values contain only intrinsic meaning.
  • model-input-ports.md — models declare the inputs they accept; Providers only map those ports onto their own wire.
  • node-package-activation.md — trusted installed package locking, contributions and Host-selected facet activation.
  • local-developer-runtime.md — local SQLite/filesystem Runtime, recovery and environment replacement.
  • runtime-execution-control.md — target durable Build dispatch, Worker lifecycle, transparent queue inspection and unambiguous Build/Operation cancellation.
  • runtime-provider-scheduling.md — explicit Provider Authorities, exact capability Routes, immutable Runtime Revisions and atomic resource tickets.
  • cli-experience.md — complete human/CI/machine terminal design, command hierarchy, visual language and decentralized Endpoint authentication.
  • runtime-adapter-loading.md — separately locked Provider and Store activation, physical-code identity, diagnostics and explicit Artifact maintenance.
  • validation-boundaries.md — the single-owner validation gates; what is mandatory, what stays optional and what must never be revalidated downstream.
  • build-archive-and-egress.md — Targets, durable Records, Artifact retention and optional Host materialization as four separate concerns.
  • speech-alignment.md — the Script and the recording as two independent observations, and what locating guarantees.
  • demo-assets.md — distribution boundary and provenance gate for documentation media.
  • source-and-run-compilation.md — mandatory Source Header, peer Author/Run graphs, deterministic composition and compilation data gates.
  • package READMEs under ../packages — executable APIs and ownership.

Video-domain specifications

The finite seven-member Seedance Kit family is complete as data-only Text Templates. Low-level Seedance invocation, Estimate, media utilities and final Blob flow remain shared and must not be reopened as Kit-specific execution code. Superseded migration ledgers live in Git history rather than the current documentation tree.

The shared svml.visual-track@1 / svml.visual-ir@1 terminal waist is frozen inside the repository before publication. Individual author Surfaces remain pre-release unless their own specification says otherwise.

Video execution records

Documentation rules

  • spec/ states normative laws and versioned contracts.
  • docs/architecture.md states current ownership and boundaries.
  • docs/implementation-status.md states repository reality.
  • docs/roadmap.md states planned work and non-goals.
  • package and example READMEs explain one executable unit.
  • docs/public/ contains documentation media cleared for redistribution; its provenance rules are tracked in demo-assets.md.

Do not preserve a superseded design in the current tree merely as a discussion log. Keep durable decisions in the current architecture/specification, and rely on Git history for rejected drafts.