mirror of https://github.com/hypit-ai/hypit.git synced 2026-11-06 18:57:21 +00:00

Files

T

rpone 3fb63600bd docs: update guides for the single-version, @narratage naming

Follows the v1 removal: the CLI is `narratage`, packages live under the
@narratage scope, there is one tsconfig.json and one `check`/`test` script
pair, wire format ids are @1, and examples/v2-bootstrap is examples/bootstrap.

Drops the v1 research oracle material from the development guide: src/,
stdlib/ and the root v1 test suite no longer exist, so the repository layout
and the command table describe one system rather than two.

Verified by running the documented `narratage check` and `narratage plan`
commands against examples/talking-film-graph-check.

2026-08-08 02:58:08 +08:00

2.3 KiB

Raw Blame History

title, description

title	description
Development Guide	Getting started with Narratage development.

Development Guide

Prerequisites

Tool	Version	Required for
Node.js	22+	everything
pnpm	9+	workspace management
Python	3.10–3.13	WhisperX and OpenCV sidecar services
uv	latest	Python environment management
ffmpeg / ffprobe	recent stable	media processing
Chrome / Chromium	recent stable	HyperFrames rendering

Node.js and pnpm are the only hard requirements. The rest are needed only for live Builds.

Daily workflow

pnpm install          # after pulling or changing dependencies
pnpm check            # TypeScript type-check
pnpm test             # full test suite

Command	What it runs
`pnpm check`	`tsc -p tsconfig.json --noEmit`
`pnpm test`	`node --import tsx --test 'packages//test//.test.ts' 'tools/*.test.mjs'`

See Testing for environment-gated tests and test patterns.

Repository layout

narratage/
├── packages/              78 workspace packages
├── spec/                  7 normative specification documents
├── docs/                  VitePress documentation site
├── examples/              runnable example sources
├── services/              Python sidecar services (whisperx, image-opencv)
├── tools/                 boundary tests and build scripts
├── package.json           root workspace manifest
├── pnpm-workspace.yaml    workspace: [packages/*]
└── tsconfig.json          TypeScript config

Guide contents

Guide	Topic
Package architecture	The four layers, dependency rules, package anatomy, facets
Adding an author package	Step-by-step: new component, Surface, activation
Adding a Provider	Step-by-step: new Endpoint adapter
Runtime Profile	JSON and TypeScript configuration, diagnostics, Build archive
Local services	WhisperX and OpenCV sidecar setup
Testing	Test runner, patterns, examples, boundary tests
Conventions	Naming, module boundaries, wire data, TypeScript config

2.3 KiB Raw Blame History Unescape Escape