Skip to content

[Documentation] 整理根目录并统一 docs 文档结构 #11

Description

@damingishere-coder

背景

仓库主页已经完成第一轮整理,但 Code 文件列表仍包含多个面向不同读者的根目录文档和启动说明,普通用户、贡献者和历史资料之间的边界不够清楚。

目标

在不破坏现有链接和启动方式的前提下,逐步将详细文档迁移到统一的 docs/ 结构,并减少根目录噪音。

建议结构

docs/
├── README.md
├── getting-started/
│   ├── windows.md
│   └── docker.md
├── user-guide/
│   ├── workflow.md
│   ├── chrome-extension.md
│   └── troubleshooting.md
├── development/
│   ├── setup.md
│   └── architecture.md
├── archive/
└── images/

验收标准

  • 盘点根目录所有 Markdown 和启动脚本的目标读者
  • 合并重复的 Windows 与 Docker 说明
  • 迁移详细文档并建立 docs/README.md 导航
  • 更新 README、CONTRIBUTING 和仓库内交叉链接
  • 为旧路径提供清晰迁移说明,避免突然出现死链
  • 历史实施方案和过期文档进入 docs/archive/
  • 根目录保留必要的 README、License、安全、贡献、路线图和主启动入口
  • AGENTS.md 继续保留在便于编程 Agent 读取的位置

非目标

本任务不重构后端、前端目录,也不在同一 PR 中修改业务逻辑。

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions