Skip to content

armgit / hypit

Public Imported from GitHub
0

Clone any viral video with AI agents. Not just a script, the whole workflow: swap the face, the words, the B-roll, ship 100 variants in one command, and get your 100M views.

docs: keep only the published documentation in docs/

rponec524d282f0fb
diff --git a/README.md b/README.md
index 33d26500..a17695d3 100644
--- a/README.md
+++ b/README.md
@@ -94,7 +94,7 @@ instead of nesting. `tagline` shows that a Segment may be roleless. Repeating th
creates multiple non-contiguous occurrences.
Marker names carry no built-in behavior: `@silence` does not mute audio; an Audio, Caption or Track
component must explicitly consume that Selection. The complete escape set and Slot parser contract
-are documented in [Script](./docs/quickstart/script.md); Slot binding is not yet exposed by the
+are documented in [Script](https://narratage.hypit.ai/quickstart/script); Slot binding is not yet exposed by the
author-facing `<script>` Surface, so the README does not pretend it is usable source syntax today.
The outer component lines are deliberately an excerpt: they show how generated media, alignment and
@@ -126,7 +126,7 @@ node --run narratage -- plan examples/talking-film-graph-check/build.svrun \
`check` verifies the Author Source and prints its typed outputs. `plan` shows the exact demanded
subgraph and every external capability a real Build would need. Planning never starts external work.
-See the [Quickstart](./docs/quickstart.md) if Corepack is unavailable or you want to run local media,
+See the [Quickstart](https://narratage.hypit.ai/quickstart) if Corepack is unavailable or you want to run local media,
WhisperX, OpenCV or HyperFrames.
## The files you control
@@ -202,7 +202,7 @@ cd /path/to/my-video
that Build; closing the observer does not cancel it. Use `status`, `queue`, `operations` and
`inspect` to see what is happening.
-Read [Run Source & Builds](./docs/quickstart/run.md) before the first paid Build. It covers Runtime
+Read [Run Source & Builds](https://narratage.hypit.ai/quickstart/run) before the first paid Build. It covers Runtime
Profiles, credentials, concurrency, cancellation and explicit reuse of previous outputs.
## Why a graph language
@@ -221,8 +221,7 @@ Narratage makes those choices visible as two peer graphs: the Author Graph expre
the Run Graph selects Targets and realizations for one Build. Core only resolves, verifies and
advances the resulting state machine; video concepts remain in independently installable packages.
-For the full model, read [Architecture](./docs/architecture.md). For the small normative laws, read
-the [Core Kernel specification](./spec/core-kernel.md).
+For the small normative laws, read the [Core Kernel specification](./spec/core-kernel.md).
## Extend it without changing Core
@@ -239,12 +238,12 @@ nominal types and explicit graph edges.
Choose the guide that matches your work:
-- [Author a video](./docs/quickstart.md)
-- [Understand package boundaries](./docs/guide/packages.md)
-- [Add an author package](./docs/guide/author-packages.md)
-- [Add a Provider](./docs/guide/providers.md)
-- [Configure a Runtime Profile](./docs/guide/runtime-profile.md)
-- [Develop Narratage itself](./docs/guide/develop.md)
+- [Author a video](https://narratage.hypit.ai/quickstart)
+- [Understand package boundaries](https://narratage.hypit.ai/guide/packages)
+- [Add an author package](https://narratage.hypit.ai/guide/author-packages)
+- [Add a Provider](https://narratage.hypit.ai/guide/providers)
+- [Configure a Runtime Profile](https://narratage.hypit.ai/guide/runtime-profile)
+- [Develop Narratage itself](https://narratage.hypit.ai/guide/develop)
## Repository map
@@ -252,7 +251,7 @@ Choose the guide that matches your work:
packages/ Core, compiler, Runtime, video packages and Provider adapters
services/ Local external programs such as WhisperX and OpenCV
examples/ Checkable sources and complete Runtime examples
-docs/ User guides, architecture and implementation records
+docs/ Source of the narratage.hypit.ai documentation site
spec/ Normative protocol and video-package contracts
tools/ Repository checks and focused development tools
```
@@ -267,9 +266,6 @@ pnpm test
pnpm docs:build
```
-Current implementation facts and remaining work live in
-[Implementation Status](./docs/implementation-status.md) and the [Roadmap](./docs/roadmap.md).
-
## License
Narratage is released under the [Narratage Open Source License](./LICENSE), based on Apache 2.0 with
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 67f17664..e3022442 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -219,30 +219,6 @@ export default defineConfig({
description: "Write the story. Compile the video.",
appearance: true,
cleanUrls: true,
- // Engineering documents live in docs/ for the repository reader; only the
- // site pages (index, quickstart, guide, zh) are built into the public site.
- srcExclude: [
- "README.md",
- "architecture.md",
- "implementation-status.md",
- "roadmap.md",
- "open-source-distribution.md",
- "build-archive-and-egress.md",
- "caption-gemini-provider-contract.md",
- "demo-assets.md",
- "graph-first-value-boundary.md",
- "hyperframes-aws-runtime.md",
- "image-transform.md",
- "kie-generation-modules.md",
- "local-developer-runtime.md",
- "media-execution-boundary.md",
- "media-inspection-and-normalization.md",
- "model-input-ports.md",
- "node-package-activation.md",
- "runtime-adapter-loading.md",
- "source-and-run-compilation.md",
- "speech-alignment.md",
- ],
markdown: {
theme: {
light: "github-light",
diff --git a/docs/README.md b/docs/README.md
deleted file mode 100644
index 2fb45a8c..00000000
--- a/docs/README.md
+++ /dev/null
@@ -1,128 +0,0 @@
-# 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`](../README.md) — understand Narratage and run the first provider-free commands.
-2. [`quickstart.md`](./quickstart.md) — install the checkout, compile a complete video graph and set
- up a project outside the repository.
-3. [`quickstart/script.md`](./quickstart/script.md) through
- [`quickstart/composition.md`](./quickstart/composition.md) — author Script, style, generation,
- timing, Tracks, Film and rendering.
-4. [`quickstart/run.md`](./quickstart/run.md) — choose Targets, configure the Runtime, build, inspect,
- reuse and retrieve results.
-
-The website publishes these pages at [narratage.hypit.ai](https://narratage.hypit.ai/).
-
-## Extend Narratage
-
-1. [`guide/develop.md`](./guide/develop.md) — repository setup and guide index.
-2. [`guide/packages.md`](./guide/packages.md) — package layers, facets and dependency rules.
-3. [`guide/author-packages.md`](./guide/author-packages.md) — add author vocabulary and graph lowering.
-4. [`guide/providers.md`](./guide/providers.md) — implement an external capability endpoint.
-5. [`guide/runtime-profile.md`](./guide/runtime-profile.md) — assemble Schedulers, Stores and Providers.
-
-## Understand the system
-
-1. [`architecture.md`](./architecture.md) — current Author Graph, Run Graph, Satisfaction, Runtime
- and package boundaries.
-2. [`../spec/core-kernel.md`](../spec/core-kernel.md) — compact normative Kernel laws for the
- current `@1` wire data.
-3. [`implementation-status.md`](./implementation-status.md) — what actually executes today.
-4. [`roadmap.md`](./roadmap.md) — remaining domain-neutral, environment and video-package work.
-5. [`open-source-distribution.md`](./open-source-distribution.md) — packaging facts and release gates.
-
-## Domain-neutral implementation records
-
-- [`graph-first-value-boundary.md`](./graph-first-value-boundary.md) — graph edges own
- dependency truth; values contain only intrinsic meaning.
-- [`model-input-ports.md`](./model-input-ports.md) — models declare the inputs they accept;
- Providers only map those ports onto their own wire.
-- [`node-package-activation.md`](./node-package-activation.md) — trusted installed package
- locking, contributions and Host-selected facet activation.
-- [`local-developer-runtime.md`](./local-developer-runtime.md) — local SQLite/filesystem
- Runtime, recovery and environment replacement.
-- [`runtime-execution-control.md`](./runtime-execution-control.md) — target durable Build dispatch,
- Worker lifecycle, transparent queue inspection and unambiguous Build/Operation cancellation.
-- [`runtime-provider-scheduling.md`](./runtime-provider-scheduling.md) — explicit Provider
- Authorities, exact capability Routes, immutable Runtime Revisions and atomic resource tickets.
-- [`cli-experience.md`](./cli-experience.md) — complete human/CI/machine terminal design,
- command hierarchy, visual language and decentralized Endpoint authentication.
-- [`runtime-adapter-loading.md`](./runtime-adapter-loading.md) — separately locked Provider
- and Store activation, physical-code identity, diagnostics and explicit Artifact maintenance.
-- [`validation-boundaries.md`](./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`](./build-archive-and-egress.md) — Targets, durable Records,
- Artifact retention and optional Host materialization as four separate concerns.
-- [`speech-alignment.md`](./speech-alignment.md) — the Script and the recording as two
- independent observations, and what locating guarantees.
-- [`demo-assets.md`](./demo-assets.md) — distribution boundary and provenance gate for documentation media.
-- [`source-and-run-compilation.md`](./source-and-run-compilation.md) — mandatory Source Header,
- peer Author/Run graphs, deterministic composition and compilation data gates.
-- package READMEs under [`../packages`](../packages) — executable APIs and ownership.
-
-## Video-domain specifications
-
-- [`../spec/script-surface.md`](../spec/script-surface.md)
-- [`../spec/author-surface-binding.md`](../spec/author-surface-binding.md)
-- [`../spec/caption-program.md`](../spec/caption-program.md)
-- [`../spec/caption-fine.md`](../spec/caption-fine.md) — implemented first field-free Caption Style
- family and its completed browser evidence.
-- [`../spec/track-authoring.md`](../spec/track-authoring.md) — shared package-authoring discipline;
- its temporal projection and occurrence-expansion laws are implemented across the current Track packages.
-- [`../spec/spatial-layout.md`](../spec/spatial-layout.md) — shared Canvas/Frame/Point/Path geometry,
- two-frame fitting, alignment and explicit backing-layer boundary.
-- [`../spec/typography-track.md`](../spec/typography-track.md) — complete two-dimensional Text model, old-system
- and editor attack audit, terminal-IR gaps and Caption feedback.
-- [`../spec/ranking-track.md`](../spec/ranking-track.md) — old Ranking audit, separate official
- components, triggered group schedule and executable renderer-neutral lowering.
-- [`../spec/media-track.md`](../spec/media-track.md) — unified Item/Sequence media model, ordered
- layers, playback, motion, internal handoffs, audio projection and Speech reuse.
-- [`../spec/deck-track.md`](../spec/deck-track.md) — independent depth-stack Deck Track, collection
- state, visible neighborhood and deterministic whole-group reflow.
-- [`../spec/audio-track.md`](../spec/audio-track.md) — explicit normalized audio inputs, temporal
- placement, sample occupancy, mixing boundary and old-system migration.
-- [`../spec/screen-overlay.md`](../spec/screen-overlay.md) — self-contained full-canvas visual
- contributions and the hard boundary against cross-Track adjustment effects.
-- [`../spec/track-composition.md`](../spec/track-composition.md)
-- [`../spec/track-expressiveness.md`](../spec/track-expressiveness.md)
-- [`../spec/visual-ir.md`](../spec/visual-ir.md)
-
-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
-
-- [`kie-generation-modules.md`](./kie-generation-modules.md)
-- [`media-inspection-and-normalization.md`](./media-inspection-and-normalization.md)
-- [`media-execution-boundary.md`](./media-execution-boundary.md)
-- [`hyperframes-aws-runtime.md`](./hyperframes-aws-runtime.md) — recoverable Endpoint semantics,
- deployment resource review and the live AWS canary.
-- [`image-transform.md`](./image-transform.md) — transforms, ordered composition and external cutout boundaries
-- [`caption-gemini-provider-contract.md`](./caption-gemini-provider-contract.md)
-- [`../services/whisperx/README.md`](../services/whisperx/README.md)
-- [`../examples/talking-head-aroll/README.md`](../examples/talking-head-aroll/README.md) — current four-take
- live acceptance and explicit historical-Candidate reuse witness.
-- [`../examples/talking-film-live/README.md`](../examples/talking-film-live/README.md)
-
-## 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.
diff --git a/docs/demo-assets.md b/docs/demo-assets.md
deleted file mode 100644
index ca647dc3..00000000
--- a/docs/demo-assets.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Demo assets
-
-`docs/public/` is copied byte-for-byte into the documentation site. It is therefore distribution
-content, not a test fixture, Build archive or ignored development output.
-
-Only brand-neutral assets cleared for repository and website redistribution belong in this
-directory. Generated Build outputs and example inputs belong under the ignored example
-`assets/` / `output/` paths.
-
-Every image, video, voice and likeness must have recorded provenance and redistribution permission.
-Replacing an asset must update its source mapping under
-`docs/.vitepress/theme/components/` and repeat that review.
diff --git a/packages/package-loader-node/README.md b/packages/package-loader-node/README.md
index 8edac845..87730056 100644
--- a/packages/package-loader-node/README.md
+++ b/packages/package-loader-node/README.md
@@ -34,6 +34,3 @@ narratage check ./main.svml --package-lock ./svml.packages.lock --root .
If `@example/cards` requires a Module exported by an installed dependency, that dependency does not
need another `--package`. Missing, digest-mismatched or ambiguous providers fail while creating the
lock, before compilation.
-
-See [`../../docs/node-package-activation.md`](../../docs/node-package-activation.md)
-for the lock, trust and restart laws.
diff --git a/packages/provider-hyperframes-aws-lambda/README.md b/packages/provider-hyperframes-aws-lambda/README.md
index 54b0eb81..1c1facaf 100644
--- a/packages/provider-hyperframes-aws-lambda/README.md
+++ b/packages/provider-hyperframes-aws-lambda/README.md
@@ -30,6 +30,5 @@ machine does not acquire a hidden FFmpeg dependency.
The production client uses the AWS SDK default credential chain. No access key is accepted by the
package configuration or written into Runtime identity.
-See [`docs/hyperframes-aws-runtime.md`](../../docs/hyperframes-aws-runtime.md) for Runtime Profile
-configuration, recovery semantics, deployment review and the opt-in live canary. The canary uses a
-fresh operation identity on every run and cleans its exact render/site prefixes by default.
+The opt-in live canary uses a fresh operation identity on every run and cleans its exact
+render/site prefixes by default.
diff --git a/packages/provider-kie/README.md b/packages/provider-kie/README.md
index fb8e127c..0e4fe0c1 100644
--- a/packages/provider-kie/README.md
+++ b/packages/provider-kie/README.md
@@ -11,8 +11,7 @@ choose another model.
It imports no exact-model package. Every supported Capability contributes one `KieRoute`: exact
Capability, return Type, request compiler, media/count limits and result packer. All Routes share one
upload, admission, paid submission, checkpoint, polling and download state machine. Model mappings
-generate twelve Routes; Background Removal contributes the thirteenth. See
-[`model-input-ports.md`](../../docs/model-input-ports.md).
+generate twelve Routes; Background Removal contributes the thirteenth.
## Supported catalog