维护这本手册
本地文件与网页编辑共用一份 MDX,日常只改内容与关系,沿用共享版式和图表。
本页内容5 节
用网页或本地文件修改
在自己的电脑运行 pnpm dev,通过右上角“编辑内容”进入本地网页编辑器,文章标题下的“编辑本页”直接进入当前文章。选择文章,修改标题、简介、所属层级、阅读顺序与正文,保存后回阅读页查看。
本机网页编辑与即时预览地址为 http://127.0.0.1:3210。本地静态预览 http://127.0.0.1:3211/StarryManual/ 也提供这两个编辑入口,跳转到同一台电脑的网页编辑器;编辑服务需要保持运行。静态预览读取构建产物,保存后可先在 3210 查看,重新构建才会更新 3211。
同一篇文章也可以直接在 content/articles/ 编辑 MDX。网页编辑器与文件编辑没有两份内容,不自动 Git 提交或推送。
手册导览是普通文章,内容位于 content/articles/start-here.mdx。侧栏的模块选择菜单和当前模块功能树从共享登记与文章层级自动生成,不另建全站功能总览页。
首页的“推荐站点”可以在网页编辑器的“首页推荐站点”中修改名称、简介、网址和排列顺序,也可以直接编辑 content/site-links.json。两种方式使用同一份数据,卡片自动排版,无需改页面代码。
GitHub Pages 提供静态阅读、搜索、图谱与蓝图工具;可视化编辑器在本地运行。也可以用 GitHub 文件编辑器修改 MDX,再由构建流程发布。带登录的在线可视化编辑仍需另行配置。
先写读者要完成的任务
每篇总结已有功能、实际用法和已确认约束,接口名、单位与默认值从当前代码核对。按用户提供的图示或现有代码说明,不自行补出新功能、架构方案或示例组件。接口片段里的占位类型明确标注,不能写成项目已有类型。
新增文章沿用所属模块的稳定标识前缀,例如 input-。新模块在共享导航中登记一次,后续文章按前缀归组;尚未单独归组的文章显示在“项目系统”,无需创建空白占位页。
用 section 表示从外到内的子模块或功能分区。例如 section: [行为执行, 树后端] 会生成“AstraAI → 行为执行 → 树后端 → 当前文章”的目录。网页编辑器中的“所属层级”填写同样的两项即可,模块总览留空。
侧栏、模块入口的功能目录、当前位置、图谱的模块与功能筛选共用这份归属。模块由文章网址前缀自动识别,section 表示子模块路径,order 决定同一目录中的阅读顺序;新增笔记不必另填文章类型、图谱分组或配色。
小功能可在同一篇文章中说明用途、操作与机制;复杂子模块再按实际需要拆页,不为凑齐“架构/使用/参考”生成重复或空白文章。
具体模块的调试操作、状态含义、异常原因和检查路线集中在该模块的“调试与排查”中。例如 Gamepad/Actions 的操作、注入边界与输入诊断统一见 Input 调试与排查。HaloDebug 维护通用工具入口、远程连接与扩展说明,通过链接指向所属模块,不再为同一领域另设调试页面。
正文链接使用 /read/文章标识。这些真实链接生成图谱与反向关联,不需要再维护关系表或节点坐标。
图表直接复用模板
在网页正文编辑器中插入“自动排版图表”,填写标题与 Mermaid 文本。关系使用 flowchart,调用先后使用 sequenceDiagram,生命周期使用 stateDiagram。现有页面可以直接作为写作参考:
- 工程分层与系统协作:项目分层与职责关系。
- Logic 生命周期:运行、取消与清理状态。
- 通道输入缓存:开窗、覆盖、关闭执行的时序。
- Async Message 蓝图收发:复用节点展示组件说明监听、解包、发送与清理,节点文本随文章保存。
本地文件使用同一 Diagram 组件。下面复用 Input 的配置关系,标签中 \n 表示换行:
<Diagram
title="配置与处理器的关系"
source={
'flowchart LR\n Setup(Input Setup) --> IMC(映射上下文)\n Setup --> Handler(共享 Handler)\n IMC --> IA(Input Action)\n IA --> Handler'
}
/>布局、四色主题、缩放与全屏由共享组件处理。日常不用写坐标、连线路径、单篇 CSS 或动画。图表出错先检查 Mermaid 关系,不重新搭页面。
正文组件
Note 提供带标题的说明卡片,Diagram 提供图表,BlueprintViewer 用于在功能说明里展示蓝图节点。三者均注册到 MDX 与网页编辑器。
介绍蓝图用法时,在正文插入“蓝图用法说明”,填写节点图标题和从 UE 复制的完整节点文本。节点文本随文章保存,读者打开页面即可看到图,不需要再手动粘贴。应在图前后说明前置配置、关键引脚与执行结果,具体格式见蓝图用法说明。
更新后的必要检查
先执行 pnpm check:content 核对元信息与站内链接。改名或删除文章时同步更新反向引用;新增图表只检查相关语法与显示。普通内容沿用共享组件,不例行做阅读适配、窄屏截图或全站视觉确认;只有布局、组件改动或实际显示问题需要时再检查对应部分。
发布构建使用 pnpm build:pages --base-path /StarryManual,再执行 pnpm check:pages 检查静态产物。是否推送发布按当前工作指令执行,本地保存与构建不会自动发布。
返回手册导览。