Files
hypit/docs/guide/develop.md
rponeawa 15efd9eec8 docs: document Hypit skill routes and state (#125)
* fix reconstruction route tooling gaps

* docs: document Hypit skill routes and state

* fix: declare visual-ir dependency
2026-08-29 01:59:28 +08:00

62 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: Development Guide
description: Getting started with Hypit development.
---
# Development Guide
## Prerequisites
| Tool | Version | Required for |
|---|---|---|
| Node.js | 22+ | everything |
| pnpm | 10.33.x | workspace management; selected by the root `packageManager` field |
| Python | 3.10–3.13 | local WhisperX and OpenCV Managed Programs |
| uv | latest | Python environment management |
| ffmpeg / ffprobe | recent stable | media processing |
| Chrome / Chromium | managed by HyperFrames | local HyperFrames rendering |
Node.js and pnpm are the only hard requirements. The rest are needed only for live Builds.
## Daily workflow
```bash
corepack enable
pnpm install --frozen-lockfile # 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` | package, service-adapter and repository-boundary tests through Node's test runner |
See [Testing](./testing.md) for environment-gated tests and test patterns.
## Repository layout
```text
hypit/
├── packages/ workspace packages
├── docs/ VitePress documentation site
├── examples/ runnable example sources
├── services/ Python services (whisperx, image-opencv)
├── test/ repository boundary tests and shared fixtures
├── package.json root workspace manifest
├── pnpm-workspace.yaml workspace: [packages/*]
└── tsconfig.json TypeScript config
```
## Guide contents
| Guide | Topic |
|---|---|
| [Hypit Skill Architecture](./skill.md) | Route entry points, tools, handoffs and durable JSON state |
| [Package architecture](./packages.md) | The five layers, dependency rules, package anatomy, facets |
| [Adding an author package](./author-packages.md) | Step-by-step: new component, Surface, vocabulary and preview, activation |
| [Adding a Provider](./providers.md) | Step-by-step: new Endpoint adapter |
| [Runtime](./runtime.md) | Profile, Workspace, execution and lifecycle boundaries |
| [Testing](./testing.md) | Test runner, patterns, examples, boundary tests |
| [Conventions](./conventions.md) | Naming, module boundaries, wire data, TypeScript config |