Skip to content

Commit ac80a8f

Browse files
committed
docs: publish complete API usage reference
1 parent 4c9825e commit ac80a8f

751 files changed

Lines changed: 223448 additions & 38927 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,6 @@ NODE_ENV=production npm start
556556
Hypha v1.0.1 publishes 15 version-aligned npm libraries. Pin the exact same version across the
557557
dependency graph. The root workspace, bundled Server, CLI, and any package marked private remain
558558
source/deployment surfaces. See the [VitePress package reference](https://codesoul-co.github.io/Hypha/packages/),
559-
[Development Workflow](docs/guides/development-workflow.md),
560559
[Releases and npm Packages](docs/guides/releases.md), and [Upgrading](UPGRADING.md).
561560

562561
| Package | Responsibility |
@@ -576,8 +575,7 @@ source/deployment surfaces. See the [VitePress package reference](https://codeso
576575
## Documentation
577576

578577
- [Bilingual VitePress guide](https://codesoul-co.github.io/Hypha/)
579-
- [Feature-by-feature map](https://codesoul-co.github.io/Hypha/guide/capability-map)
580-
- [Complete module/class/function API](https://codesoul-co.github.io/Hypha/api/)
578+
- [Complete API reference by package, module, class, function, type, and constant](https://codesoul-co.github.io/Hypha/api/)
581579
- [Seven isolated feature examples and full-system example](https://codesoul-co.github.io/Hypha/guide/examples)
582580
- [Official website](https://hypha.code-soul.com/)
583581
- [Documentation index](docs/README.md)

‎README.zh-CN.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,6 @@ NODE_ENV=production npm start
531531
Hypha v1.0.1 已发布 15 个版本对齐的 npm Library;应用应在整个依赖图中固定相同的精确版本。
532532
根 Workspace、内置 Server、CLI 及所有标记为 private 的 Package 仍是源码/部署 Surface。参见
533533
[VitePress Package 文档](https://codesoul-co.github.io/Hypha/zh/packages/)、
534-
[开发与发布流程](website/zh/guide/development-workflow.md)、
535534
[Release 与 npm Package](docs/guides/releases.md)及[升级指南](UPGRADING.md)。
536535

537536
| Package | 职责 |
@@ -551,8 +550,7 @@ Hypha v1.0.1 已发布 15 个版本对齐的 npm Library;应用应在整个依
551550
## 文档
552551

553552
- [中英双语 VitePress 文档](https://codesoul-co.github.io/Hypha/zh/)
554-
- [逐功能地图](https://codesoul-co.github.io/Hypha/zh/guide/capability-map)
555-
- [逐模块/类/函数完整 API](https://codesoul-co.github.io/Hypha/zh/api/)
553+
- [按包、模块、类、函数、类型与常量拆分的完整 API 参考](https://codesoul-co.github.io/Hypha/zh/api/)
556554
- [7 个独立功能示例与完整系统示例](https://codesoul-co.github.io/Hypha/zh/guide/examples)
557555
- [官方网站](https://hypha.code-soul.com/)
558556
- [文档索引](docs/README.md)

‎docs/README.md‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@
22

33
This directory contains public documentation for using hypha APIs, specs, runtime conventions, and extension points. It intentionally describes stable contracts rather than internal planning notes.
44

5-
The published v1.0.1 user guide, feature map, complete generated API reference, FSM walkthrough, and
5+
The published v1.0.1 user guide, complete generated API reference, FSM walkthrough, and
66
full-system example are available at
77
[codesoul-co.github.io/Hypha](https://codesoul-co.github.io/Hypha/). The project website is
88
[hypha.code-soul.com](https://hypha.code-soul.com/).
99

10-
## Start Here
10+
## API and usage documentation
1111

12-
- [Feature Map](https://codesoul-co.github.io/Hypha/guide/capability-map): end-to-end execution stages mapped to packages, modules, principal classes/functions, and isolated examples.
13-
- [Complete API Reference](https://codesoul-co.github.io/Hypha/api/): every public package export grouped by source module, including signatures and public class/interface members.
12+
- [Complete API Reference](https://codesoul-co.github.io/Hypha/api/): every public package export grouped by source module, including full declarations, imports, function parameters and returns, and class/interface members.
1413
- [Runnable Examples](https://codesoul-co.github.io/Hypha/guide/examples): seven isolated feature entries, a 15-package tour, DomainPack compilation, Server Run submission, and custom FSM control.
1514
- [Architecture Reference](reference/architecture.md): package responsibilities, harness semantics, runtime boundaries, and extension rules.
1615
- [Runtime Model](reference/runtime-model.md): DomainPack, Session, Run, Event, durable orchestration, FSM, replay, audit, regression, and concurrency conventions.
@@ -35,8 +34,6 @@ full-system example are available at
3534

3635
## Guides
3736

38-
- [Development Workflow](guides/development-workflow.md): direct `dev` maintenance, release gates,
39-
and the `dev` → `main` publication path.
4037
- [Releases and npm Packages](guides/releases.md): version alignment, package verification,
4138
publication boundaries, and the standalone consumer example.
4239
- [Upgrading Hypha](../UPGRADING.md): npm and source-release update, configuration migration,

‎docs/guides/development-workflow.md‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

‎docs/guides/releases.md‎

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -28,29 +28,6 @@ or operate a Server. The complete v1.0.0 package atlas is available in the
2828
- A release is not public until the maintainer has published packages and created the matching Git
2929
tag and release notes. A version in `package.json` alone is not proof of registry availability.
3030

31-
## Maintainer publication
32-
33-
Run publication only from the fully validated `main` release commit after `dev` has passed every
34-
base release gate and has been merged into `main`. Online-provider maintainers may additionally run `npm run test:acceptance:online`,
35-
and infrastructure operators may run `npm run test:acceptance:manual` when those environments are
36-
available. Both commands fail closed when their required parameters are absent. First authenticate
37-
the authorized npm organization account and verify the scope:
38-
39-
```bash
40-
npm whoami
41-
npm run release:check:npm
42-
npm publish packages/core --access public
43-
```
44-
45-
Publish dependencies before their consumers. Continue with Storage/FSM/Inference/Models/Memory/
46-
Tools, then Skills/MCP, Domain/Kernel, Harness, local adapters, caches, and testing. Use npm
47-
provenance in the release workflow where the registry and CI identity support it. Never publish
48-
from any retired or unmaintained branch.
49-
50-
After publication, create a clean temporary consumer, install exact versions from the registry,
51-
compile it, run its tests, and compare the package metadata with the release commit. Only then create
52-
the matching Git tag and public release entry.
53-
5431
## Consumer example
5532

5633
[`examples/release-agent`](../../examples/release-agent/README.md) shows a product-owned Agent with

0 commit comments

Comments
 (0)