34 lines
2.5 KiB
Markdown
34 lines
2.5 KiB
Markdown
|
|
# 遗留文档归档说明(Archive / Disposition)
|
|||
|
|
|
|||
|
|
> 本文件记录项目根目录 `docs/` 下**遗留文档的处置结果**,作为整合与删除的追踪依据。原文件删除后,此文件保留其去向,保证可追溯。
|
|||
|
|
|
|||
|
|
## 处置汇总
|
|||
|
|
|
|||
|
|
| 原文件 | 评估 | 处置 | 落点 |
|
|||
|
|
| --- | --- | --- | --- |
|
|||
|
|
| `docs/code-structure-standards.md` | 现行、长期有效的工程规范 | **整合**(全量保留) | `architecture/standards/code-structure-standards.md` |
|
|||
|
|
| `docs/code-structure-audit-2026-04-08.md` | 历史审计记录,有参考价值 | **整合**(全量保留) | `architecture/standards/code-structure-audit-2026-04-08.md` |
|
|||
|
|
| `docs/MCP_HTTP_INTEGRATION.md` | 现行 MCP 使用文档,内容详实 | **合并**(内容并入,超集) | `integrations/mcp.md` |
|
|||
|
|
| `docs/UPGRADE_v0.9.6.md` | 历史发布记录(多已吸收为基线) | **整合**为发布记录 | `releases/v0.9.6.md` |
|
|||
|
|
| `docs/MIGRATION.md` | **过时**:指向已不存在的按钮文档/`/design` 路由 | **弃置**(归档说明,不保留实质内容) | 本文件 |
|
|||
|
|
| `docs/DOCKER_DOCS_SETUP.md` | **过时**:`/design` 文档功能已不在代码中,当前 compose 无 `./docs` 挂载 | **弃置**(归档说明,不保留实质内容) | 本文件 |
|
|||
|
|
|
|||
|
|
## 弃置内容说明
|
|||
|
|
|
|||
|
|
### `docs/MIGRATION.md`(弃置)
|
|||
|
|
该文档描述「按钮扩展组件文档整合方案」,指向 `src/components/docs/ButtonExtensions.md` 与 `/design/button-designs` 路由。经核查:
|
|||
|
|
- `frontend/src` 中无对应消费者,`docsMenuData.json` 引用的 `/docs/*.md` 文件在仓库中不存在;
|
|||
|
|
- `/design` 相关文档功能已不在当前代码中;
|
|||
|
|
- 故判定为**过时遗留**,实质内容不再保留。
|
|||
|
|
|
|||
|
|
### `docs/DOCKER_DOCS_SETUP.md`(弃置)
|
|||
|
|
该文档描述「将 `./docs` 卷挂载到容器 `/app/dist/docs` 以服务设计文档」。经核查:
|
|||
|
|
- 当前 `docker-compose.yml` 仅挂载 `./storage`、`./backend/logs`(及 mysql/redis storage);**无 `./docs` 挂载**;
|
|||
|
|
- `/docs/*.md` 设计文档文件与消费方在当前仓库中不存在;
|
|||
|
|
- 涉及的 `nex-design`、`/design`、PM2/ecosystem 等描述与当前项目结构不符;
|
|||
|
|
- 故判定为**过时遗留**,实质内容不再保留。
|
|||
|
|
|
|||
|
|
## 相关提示
|
|||
|
|
- 若未来重新引入「程序内文档中心」能力,须先在 SDD 登记规格(DV/FR),再落地,避免再次产生无人消费的遗留文档。
|
|||
|
|
- 敏感内容(如默认口令、历史地址)仅保留在相应发布/部署文档的历史上下文中,不鼓励据此推断现状。
|