NoteConnection Documentation Hub¶
This site adopts the Diataxis framework to make documentation easier to navigate and maintain.
Documentation Stability¶
- Use
npm run docs:diataxis:checkto validate Diataxis mapping consistency. - Use
npm run docs:site:buildto validate page rendering and link stability. - Use
npm run docs:site:servefor local browsing during iterative doc updates. - Use Working Docs / Brainstorms and Working Docs / Solutions for in-progress alignment artifacts and durable solution notes.
- Use Open Goal Audit (2026-05-10) as the all-docs unresolved-goal snapshot.
- Use Agent Knowledge Workspace Graph Preview and Review Closure (2026-06-20) for the current matched-file, Focus runtime reuse, Godot Future Path dispatch, DAG-context, and final-answer review closure.
- Use Agent Knowledge DAG Answer Contract Plan (2026-06-17) for the clarified existing-DAG answer contract and graph-conditioned context assembly direction.
- Use Architecture Progress Alignment and Mainline Plan (2026-06-06) for the current code-vs-plan comparison and next mainline sequence.
- Track the Program A-F substrate/export closure in Development Progress Dashboard and Deep Student Comparison Next-Phase Plan.
- 当前 agent knowledge 的命中文件、Focus runtime 复用、Godot Future Path 调度、DAG 上下文与最终回答审核收口请查看 Agent 知识工作区图预览与回答审核收口(2026-06-20)。
- 当前 agent knowledge 的现有 DAG 回答契约与 graph-conditioned context assembly 方向请查看 Agent Knowledge DAG 回答契约方案(2026-06-17)。
- 当前代码 / 方案对比与后续主线顺序请查看 架构推进对齐与主线推进方案(2026-06-06)。
- Program A-F 的 substrate / export 收口状态请查看 Development Progress Dashboard 与 Deep Student Comparison Next-Phase Plan。
English¶
- Start with Diataxis Overview.
- Follow First Run Tutorial.
- Use How-To Guides for operational tasks.
- Bootstrap local Godot sidecars via Bootstrap Godot Sidecar.
- Use Publish Docs to GitHub Pages for docs delivery + rollback.
- Configure local runtime policy via Configure app_config.toml.
- Follow Godot + NoteMD + Markdown Workflows before integrated feature development.
- Use Reference for contracts and release governance.
- Use Godot + NoteMD + Markdown Interfaces for field-level API/message contracts.
- Use Multi-Platform Build Flows for the audited desktop/mobile/publish/release build matrix behind the LFS migration.
- Use app_config.toml Schema for exact config keys/defaults/effects.
- Use Explanation for architecture decisions.
- Use Startup Node Update Acceleration Plan for phased performance rollout.
- Use Knowledge Mastery Evolution Roadmap for the next-stage learning-system strategy.
- Use Development Progress Dashboard for implementation status, code evidence anchors, and operational runbook flow.
- Use Brainstorms for current requirement-alignment outputs before planning.
- Use Solutions for baseline implementation decisions and recovery patterns.
- Use Agent Knowledge Workspace Graph Preview and Review Closure (2026-06-20) when working on matched-file click affordances, source highlighting, Focus runtime docking, Godot Future Path dispatch, DAG-context usage, or final public-answer review.
- Use Agent Knowledge DAG Answer Contract Plan (2026-06-17) when deciding how the existing DAG should feed agent answers without polluting the public answer surface.
- Use Architecture Progress Alignment and Mainline Plan (2026-06-06) when deciding whether a previous architecture requirement is implemented, operational-only, or still pending.
- Use Git LFS Asset Migration for the phased repository/runtime decoupling strategy.
- Use Sidecar Supply Feasibility for the cost/user-friction/maintainer-burden decision matrix behind mirror choices.
- Use Anti-Fragile Sidecar Supply Strategy for the cache-first, mirror-aware, offline-seed path that explicitly rejects download-only replacement.
- Use Open Goal Audit (2026-05-10) for cross-doc unresolved-goal status.
中文¶
- 从 Diataxis 概览 开始。
- 按照 首次运行教程 上手。
- 面向操作任务请使用 操作指南。
- 本地物化 Godot sidecar 请参考 引导 Godot Sidecar。
- 文档发布与回滚请参考 发布文档到 GitHub Pages。
- 本地运行策略配置请参考 配置 app_config.toml。
- 进入集成功能开发前请先完成 Godot + NoteMD + Markdown 工作流 基线。
- 需要接口与发布信息请查看 参考文档。
- 字段级 API/桥接契约请查看 Godot + NoteMD + Markdown 接口。
- 桌面/移动/发布/release 的构建矩阵请查看 多平台构建流程。
- 参数键/默认值/效果请查看 app_config.toml 结构。
- 需要理解架构决策请查看 解释文档。
- 启动性能分阶段落地请查看 启动节点更新提速方案。
- 下一阶段学习系统战略请查看 知识彻底掌握演进路线图。
- 需要查看实现进度、代码证据与调试链路请查看 开发进度看板。
- 需求对齐与规划前输出请查看 Brainstorms。
- 沉淀的解决方案基线请查看 Solutions。
- 处理命中文件可点击提示、source highlight、Focus runtime 停靠、Godot Future Path 调度、DAG context 使用或最终公开回答审核时,请查看 Agent 知识工作区图预览与回答审核收口(2026-06-20)。
- 判断现有 DAG 应如何进入 agent answer、且不污染公开回答区时,请查看 Agent Knowledge DAG 回答契约方案(2026-06-17)。
- 判断先前架构要求是“已实现”“仅为 operational baseline”还是“仍待推进”时,请查看 架构推进对齐与主线推进方案(2026-06-06)。
- 仓库与运行时资产解耦迁移请查看 Git LFS 资产迁移。
- 镜像方案的成本 / 用户门槛 / 维护负担矩阵请查看 Sidecar 供给可行性。
- 桌面 sidecar 的缓存优先 / 镜像感知 / 离线种子迁移路径请查看 反脆弱 Sidecar 供给策略。
- 全量文档未完成目标快照请查看 Open Goal Audit (2026-05-10)。