Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,8 @@ feature_dom_marker(group = ..., key = ..., name = ...)

### 2. 可运行 first-component 与错误路径(#24、#25)

- #24 是当前实现批次:提供 `yarn example:first-component`,让 typed store/action 的首次成功路径可以直接运行;
- #25 将常见 Koka 编译错误整理为 symptom → cause → minimal fix cookbook;
- #24 已由 PR #28 合并:`yarn example:first-component` 提供 typed store/action 的可执行首次成功路径;
- #25 是当前开发批次:将常见 Koka 编译错误、framework authoring contract 与 recovery symptom 整理为 symptom → cause → minimal fix cookbook;
- 文档示例尽量引用持续编译的源码,减少 snippet drift。

### 3. 安全 tooling surface(#19、#26)
Expand Down Expand Up @@ -195,8 +195,8 @@ issue、PR 及影响结论的进度更新统一使用中英双语:标题采用
- [#17 版本化 runtime snapshot 并定义兼容迁移 / Version runtime snapshots and define compatible migration](https://github.com/Respo/explore-react.koka/issues/17):已由 PR #21 合并;snapshot envelope、legacy compatibility 与安全回退已落地;
- [#18 定义组件 effect cleanup 生命周期 / Define the component effect cleanup lifecycle](https://github.com/Respo/explore-react.koka/issues/18):已由 PR #22 合并;effect/resource author API、host registry、HMR dispose、测试与文档已落地;
- [#23 提供单一组件作者导入入口 / Provide a single component-author import](https://github.com/Respo/explore-react.koka/issues/23):已由 PR #27 合并;单一 author import 与边界检查已落地;
- [#24 交付可运行的首个组件示例 / Ship a runnable first-component example](https://github.com/Respo/explore-react.koka/issues/24):当前开发批次,提供可执行且持续编译的首次成功路径;
- [#25 发布组件编译错误 cookbook / Publish a component compile-error cookbook](https://github.com/Respo/explore-react.koka/issues/25):下一批次,按用户看到的错误组织诊断;
- [#24 交付可运行的首个组件示例 / Ship a runnable first-component example](https://github.com/Respo/explore-react.koka/issues/24):已由 PR #28 合并;提供可执行且持续编译的首次成功路径;
- [#25 发布组件编译错误 cookbook / Publish a component compile-error cookbook](https://github.com/Respo/explore-react.koka/issues/25):当前开发批次;按用户看到的错误组织 Koka 编译、框架边界与恢复诊断;
- [#19 发布 agent-safe store catalog 与校验 action dispatch / Publish an agent-safe store catalog and validated action dispatch](https://github.com/Respo/explore-react.koka/issues/19):后续探索批次;先稳定人类用户 author surface,再服务 tools/agents;
- [#26 提供只读 action/store 调试面板 / Provide a read-only action/store inspector](https://github.com/Respo/explore-react.koka/issues/26):依赖 #19 的安全 catalog,作为后续调试体验。

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,10 @@ are advanced integration topics, not prerequisites:

Start with the bilingual [component quick start](docs/quick-start.md), then use
the [one-page component author API](docs/component-authoring.md) as the normal
reference. Persistent feature identity, recovery, and cross-domain/local
transitions are introduced only when needed:
reference. When an error interrupts that path, use the bilingual
[component error and diagnosis cookbook](docs/component-error-cookbook.md).
Persistent feature identity, recovery, and cross-domain/local transitions are
introduced only when needed:

- [component lifecycle](docs/component-lifecycle.md)
- [effect lifecycle](docs/effect-lifecycle.md)
Expand Down
4 changes: 4 additions & 0 deletions docs/component-authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import explore/react

先运行 [first component](quick-start.md):它的 component module 是当前 public API 的可执行参考,host/runtime 细节单独留在 advanced entry。

如果编译器报错、label 不匹配或 HMR 后 state 回退,先查 [Component 错误与诊断 cookbook](component-error-cookbook.md)。它会区分 Koka 类型错误、框架 authoring contract 和安全恢复回退。

## 1. Elements

| 任务 | 推荐 API |
Expand Down Expand Up @@ -82,6 +84,8 @@ It re-exports elements/VDOM, the serializable action protocol, and component lif

Run the [first component](quick-start.md) first. Its component module is an executable reference for the current public API; host/runtime details stay in a separate advanced entry.

For a compiler error, a mismatched label, or state that falls back after HMR, start with the [Component error and diagnosis cookbook](component-error-cookbook.md). It distinguishes Koka type errors, the framework authoring contract, and safe recovery fallback.

## 1. Elements

| Task | Preferred API |
Expand Down
Loading
Loading