Skip to content

docs(architecture): 对齐 README/CONTRIBUTING 与实际实现并加一致性检查 #30

Description

@ShuhaoZhangTony

背景:文档中仍有历史依赖与当前实现并存,增加新同学上手成本。\n\n目标:建立文档与代码的一致性治理机制。\n\n范围:\n- 更新 README/CONTRIBUTING 的依赖与启动说明\n- 明确 CLI/API/Runtime 边界与目录职责\n- 在 PR 模板或 CI 中加入 docs consistency checklist\n\n验收标准:\n- 文档描述与当前入口一致\n- 过时依赖引用被清理\n- 涉及启动链路改动时有文档同步约束\n\n证据:当前文档可见历史组件描述与现有实现并存。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions