docs(plan): sync api task board completion state
This commit is contained in:
@@ -23,7 +23,7 @@
|
|||||||
| ID | 范围 | 目标改动 | 主要路径 | 风险 | 状态 | 领取人 |
|
| ID | 范围 | 目标改动 | 主要路径 | 风险 | 状态 | 领取人 |
|
||||||
|----|------|----------|----------|------|------|--------|
|
|----|------|----------|----------|------|------|--------|
|
||||||
| `R1` | Rendering / 重复目录归位 | 把旧顶层 `CameraRenderer`、`SceneRenderer`、`CameraRenderRequest`、`SceneRenderRequestPlanner`、`SceneRenderRequestUtils`、`RenderCameraData`、`RenderResourceCache`、`RenderSceneExtractor`、`RenderSceneUtility` 合并到真实子模块位置 | `docs/api/XCEngine/Rendering/**` | `medium` | `completed` | 当前会话 |
|
| `R1` | Rendering / 重复目录归位 | 把旧顶层 `CameraRenderer`、`SceneRenderer`、`CameraRenderRequest`、`SceneRenderRequestPlanner`、`SceneRenderRequestUtils`、`RenderCameraData`、`RenderResourceCache`、`RenderSceneExtractor`、`RenderSceneUtility` 合并到真实子模块位置 | `docs/api/XCEngine/Rendering/**` | `medium` | `completed` | 当前会话 |
|
||||||
| `R2` | Rendering / 旧命名残留审计 | 处理 `ObjectIdEncoding`、`ObjectIdPass`、`RenderMaterialUtility`、`VisibleRenderObject`,判定迁移到哪里或删除 | `docs/api/XCEngine/Rendering/**` | `medium` | `pending` | |
|
| `R2` | Rendering / 旧命名残留审计 | 处理 `ObjectIdEncoding`、`ObjectIdPass`、`RenderMaterialUtility`、`VisibleRenderObject`,判定迁移到哪里或删除 | `docs/api/XCEngine/Rendering/**` | `medium` | `completed` | 当前会话 |
|
||||||
| `E1` | Editor / 历史失效页清理 | 移除 `XCUIDemoPanel` canonical 页面,修正 `panels.md`、`ImGuiTransitionBackend.md` 等反向链接 | `docs/api/XCEngine/Editor/panels/**` | `low` | `completed` | 当前会话 |
|
| `E1` | Editor / 历史失效页清理 | 移除 `XCUIDemoPanel` canonical 页面,修正 `panels.md`、`ImGuiTransitionBackend.md` 等反向链接 | `docs/api/XCEngine/Editor/panels/**` | `low` | `completed` | 当前会话 |
|
||||||
| `V1` | Resources / Volume | 建立 `Volume.md`、`VolumeField.md`、`VolumeFieldLoader.md`,同步 `Resources.md` | `docs/api/XCEngine/Resources/Volume/**` | `low` | `completed` | 当前会话 |
|
| `V1` | Resources / Volume | 建立 `Volume.md`、`VolumeField.md`、`VolumeFieldLoader.md`,同步 `Resources.md` | `docs/api/XCEngine/Resources/Volume/**` | `low` | `completed` | 当前会话 |
|
||||||
| `V2` | Components / Volume | 建立 `VolumeRendererComponent.md`,同步 `Components.md` | `docs/api/XCEngine/Components/VolumeRendererComponent/**` | `low` | `completed` | 当前会话 |
|
| `V2` | Components / Volume | 建立 `VolumeRendererComponent.md`,同步 `Components.md` | `docs/api/XCEngine/Components/VolumeRendererComponent/**` | `low` | `completed` | 当前会话 |
|
||||||
@@ -32,11 +32,20 @@
|
|||||||
| `U1` | UI / Widgets Helpers | 建立 `UIDragDropInteraction.md`、`UIScrollModel.md`,同步 `Widgets.md` | `docs/api/XCEngine/UI/Widgets/**` | `high-risk` | `completed` | 当前会话 |
|
| `U1` | UI / Widgets Helpers | 建立 `UIDragDropInteraction.md`、`UIScrollModel.md`,同步 `Widgets.md` | `docs/api/XCEngine/UI/Widgets/**` | `high-risk` | `completed` | 当前会话 |
|
||||||
| `ED1` | Editor / ComponentEditors | 建立 `VolumeRendererComponentEditor.md`,同步 `ComponentEditors.md` | `docs/api/XCEngine/Editor/ComponentEditors/**` | `low` | `completed` | 当前会话 |
|
| `ED1` | Editor / ComponentEditors | 建立 `VolumeRendererComponentEditor.md`,同步 `ComponentEditors.md` | `docs/api/XCEngine/Editor/ComponentEditors/**` | `low` | `completed` | 当前会话 |
|
||||||
| `ED2` | Editor / panels Material Authoring | 建立 `MaterialInspectorMaterialState.md`、`MaterialInspectorMaterialStateIO.md`,同步 `panels.md` | `docs/api/XCEngine/Editor/panels/**` | `low` | `completed` | 当前会话 |
|
| `ED2` | Editor / panels Material Authoring | 建立 `MaterialInspectorMaterialState.md`、`MaterialInspectorMaterialStateIO.md`,同步 `panels.md` | `docs/api/XCEngine/Editor/panels/**` | `low` | `completed` | 当前会话 |
|
||||||
| `RR1` | RHI 内容回归 | 根据当前真实头文件更新 `RHI*`、`D3D12`、`OpenGL`、`Vulkan` 文档内容与结构 | `docs/api/XCEngine/RHI/**` | `high-risk` | `pending` | |
|
| `RR1` | RHI 内容回归 | 根据当前真实头文件更新 `RHI*`、`D3D12`、`OpenGL`、`Vulkan` 文档内容与结构 | `docs/api/XCEngine/RHI/**` | `high-risk` | `completed` | 当前会话 |
|
||||||
| `RR2` | Rendering / Passes 内容回归 | 根据当前修改中的 builtin pass 头文件更新文档内容与链接 | `docs/api/XCEngine/Rendering/Passes/**` | `high-risk` | `pending` | |
|
| `RR2` | Rendering / Passes 内容回归 | 根据当前修改中的 builtin pass 头文件更新文档内容与链接 | `docs/api/XCEngine/Rendering/Passes/**` | `high-risk` | `completed` | 当前会话 |
|
||||||
| `RR3` | Rendering / Materials 内容回归 | 把 `RenderMaterialResolve` 相关文档与当前头文件重新对齐 | `docs/api/XCEngine/Rendering/Materials/**` | `high-risk` | `completed` | 当前会话 |
|
| `RR3` | Rendering / Materials 内容回归 | 把 `RenderMaterialResolve` 相关文档与当前头文件重新对齐 | `docs/api/XCEngine/Rendering/Materials/**` | `high-risk` | `completed` | 当前会话 |
|
||||||
| `G1` | 全量审计与空目录清理 | 跑审计、清空旧重复目录、清理空目录与错链 | `docs/api/_meta/**`, `docs/api/XCEngine/**` | `medium` | `pending` | |
|
| `G1` | 全量审计与空目录清理 | 跑审计、清空旧重复目录、清理空目录与错链 | `docs/api/_meta/**`, `docs/api/XCEngine/**` | `medium` | `pending` | |
|
||||||
|
|
||||||
|
## 最新进度
|
||||||
|
|
||||||
|
- 截至 `2026-04-10 18:36`,`docs/api/_tools/audit_api_docs.py` 审计已全绿:
|
||||||
|
- `Invalid header refs = 0`
|
||||||
|
- `Invalid source refs = 0`
|
||||||
|
- `Broken .md links = 0`
|
||||||
|
- `Missing directory index pages = 0`
|
||||||
|
- 当前第二轮任务板里真正剩余的结构性收口项主要是 `G1`,即历史空目录与重复目录的继续清理。
|
||||||
|
|
||||||
## 推荐阶段顺序
|
## 推荐阶段顺序
|
||||||
|
|
||||||
### 第一阶段
|
### 第一阶段
|
||||||
|
|||||||
@@ -46,9 +46,9 @@
|
|||||||
|
|
||||||
### 剩余结构问题
|
### 剩余结构问题
|
||||||
|
|
||||||
- `AGENT.md`、`docs/api-skill.md` 与 `docs/used/**` 的 active/archive 入口口径仍需同步到新根树与新任务板。
|
- `RHI`、`Rendering/Passes`、`Rendering/Materials` 等高风险内容回归任务已经完成,当前审计维持全绿。
|
||||||
- `RHI`、`Rendering/Passes`、`Rendering/Materials` 等高风险内容回归任务仍未收口。
|
- 历史空目录与重复目录的进一步清理仍待继续验证,这部分仍对应 `S9`。
|
||||||
- 历史空目录与重复目录的进一步清理仍待继续验证。
|
- 后续重点已经从“大面积补缺页”转成“任务板/入口状态同步 + 空目录收口 + 新增头文件增量同步”。
|
||||||
|
|
||||||
### 当前发现的可疑空目录
|
### 当前发现的可疑空目录
|
||||||
|
|
||||||
@@ -145,10 +145,11 @@
|
|||||||
|
|
||||||
## 备注
|
## 备注
|
||||||
|
|
||||||
- 当前阶段已经从“补缺页”转为“入口口径同步 + 高风险内容回归”。
|
- 当前阶段已经从“补缺页”转为“空目录清理 + 入口状态同步 + 增量回归维护”。
|
||||||
- 下一轮优先收口:
|
- 下一轮优先收口:
|
||||||
- `AGENT.md`
|
- `S9` 对应的历史空目录清理
|
||||||
- `docs/api-skill.md`
|
- `docs/api/_meta/rebuild-status.md` 的例行审计回写
|
||||||
- `docs/used/API文档实时同步任务池_2026-04-03*.md`
|
- 后续新增或继续波动的高风险源码路径增量同步:
|
||||||
- `docs/api/XCEngine/RHI/**`
|
- `engine/include/XCEngine/RHI/**`
|
||||||
- `docs/api/XCEngine/Rendering/**`
|
- `engine/include/XCEngine/Rendering/Passes/**`
|
||||||
|
- `new_editor/include/XCEditor/**`
|
||||||
|
|||||||
Reference in New Issue
Block a user