Update documentation from Claude Code
This commit is contained in:
+12
-59
@@ -1,48 +1,16 @@
|
||||
# AI 开发入口
|
||||
|
||||
> 给 AI coding agent 的项目入口。这里负责导航和流程,硬性编码规则见 [`05-coding-rules.md`](05-coding-rules.md)。
|
||||
|
||||
## 一句话定位
|
||||
|
||||
Skelet 是面向 AI coding 开发者的开源项目骨架导航与评测网站。
|
||||
|
||||
第一版 MVP 只做:场景分类、语言 / 框架筛选、骨架项目详情、AI Coding 友好度评分、基础搜索和后台内容维护。
|
||||
|
||||
## 必读顺序
|
||||
|
||||
每次开始写代码前,按这个顺序建立上下文:
|
||||
|
||||
1. [`../AGENTS.md`](../AGENTS.md):仓库级规则。
|
||||
2. [`01-vision.md`](01-vision.md):为什么做、为谁做、什么不做。
|
||||
3. [`02-requirements.md`](02-requirements.md):MVP 要什么、怎么算达成。
|
||||
4. [`03-tech-stack.md`](03-tech-stack.md):既定技术选型。
|
||||
5. [`04-architecture.md`](04-architecture.md):系统结构、职责划分、数据模型和关键难点。
|
||||
6. [`05-coding-rules.md`](05-coding-rules.md):写代码前必须遵守的规则。
|
||||
7. [`06-tasks.md`](06-tasks.md):领取本轮唯一任务。
|
||||
8. [`../progress.md`](../progress.md):历史执行记录、验证结果、阻塞点和关键决策。
|
||||
9. [`current-state.md`](current-state.md):当前代码现实、可运行命令、下一步任务。
|
||||
> 给 AI coding agent 的每轮开工流程。项目定位、必读顺序、工作规则、技术边界的唯一权威版本在 [`../AGENTS.md`](../AGENTS.md),本文不重复;硬性编码规则见 [`05-coding-rules.md`](05-coding-rules.md)。
|
||||
|
||||
## 固定开工流程
|
||||
|
||||
1. `pwd`:确认在 `D:\OPC\skelet`。
|
||||
1. `pwd`:确认在仓库根目录(标准开发环境为 WSL/Linux,路径 `/mnt/d/OPC/skelet`)。
|
||||
2. 读 [`../progress.md`](../progress.md) 和 [`current-state.md`](current-state.md)。
|
||||
3. 如果是 git 仓库,运行 `git log --oneline -5`;当前阶段尚未初始化 git 时记录事实即可。
|
||||
4. 如果 `init.ps1` / `init.sh` 已配置,运行标准验证;如果脚本仍是占位,先完成 `T-001`。
|
||||
3. 运行 `git log --oneline -5`,了解最近提交。
|
||||
4. 如果 `init.sh` 已配置真实命令,运行标准验证;如果脚本仍是占位,先完成 `T-001`。
|
||||
5. 如果基线已坏,先修基线,不在坏的起点上叠新功能。
|
||||
6. 基线绿了,再从 [`06-tasks.md`](06-tasks.md) 领取唯一任务。
|
||||
|
||||
## 当前阶段
|
||||
|
||||
当前项目处于:MVP 起步前的 harness 文档初始化阶段。
|
||||
|
||||
优先路径:
|
||||
|
||||
1. Phase 0:初始化 Wagtail 项目骨架和可运行基线。
|
||||
2. Phase 1:建立内容模型和后台维护流程。
|
||||
3. Phase 2:实现前台浏览、筛选、详情、评分展示。
|
||||
4. Phase 3:完善搜索、SEO、sitemap、部署说明。
|
||||
5. Phase 4:上线前验收、备份、SQLite WAL、迁移 PostgreSQL 的触发条件。
|
||||
|
||||
## 领取任务规则
|
||||
|
||||
- 只领取第一个状态为 `TODO` 且依赖均为 `DONE` 的任务。
|
||||
@@ -55,22 +23,7 @@ Skelet 是面向 AI coding 开发者的开源项目骨架导航与评测网站
|
||||
|
||||
## MVP 边界
|
||||
|
||||
MVP 只做:
|
||||
|
||||
- 按场景展示骨架项目。
|
||||
- 按语言、框架、数据库、AI 友好度筛选。
|
||||
- 骨架详情页展示适合场景、技术栈、成熟度、维护状态、功能清单、AI Coding 友好度和推荐理由。
|
||||
- 后台可以维护项目、分类、标签、评分和文章。
|
||||
- 基础 SEO、站点地图、公开页面可被搜索引擎抓取。
|
||||
|
||||
MVP 不做:
|
||||
|
||||
- 前台用户注册、登录、收藏、评论。
|
||||
- 付费会员、支付、赞助位后台结算。
|
||||
- 自动抓取 GitHub 数据。
|
||||
- 复杂全文搜索引擎,如 Elasticsearch。
|
||||
- 多语言站点。
|
||||
- PostgreSQL 生产化迁移,除非 SQLite 触发迁移条件。
|
||||
MVP 功能范围以 [`02-requirements.md`](02-requirements.md) 为唯一权威,本文不重复清单。一句话版本:只做场景分类、筛选、详情页、文章、后台维护和基础 SEO;不做用户系统、支付、自动抓取、复杂搜索、多语言。
|
||||
|
||||
## 事实来源
|
||||
|
||||
@@ -78,7 +31,7 @@ MVP 不做:
|
||||
|
||||
- `docs/02-requirements.md` 的 MVP 需求与验收标准。
|
||||
- `docs/03-tech-stack.md` 的技术选型。
|
||||
- `docs/04-architecture.md` 的数据模型和模块边界。
|
||||
- `docs/04-architecture.md` 的数据模型、评分维度和模块边界。
|
||||
- `docs/api.md` 的公开接口和后台边界。
|
||||
- 未来代码中的 Wagtail models、migrations、templates 和 tests。
|
||||
|
||||
@@ -88,11 +41,11 @@ MVP 不做:
|
||||
|
||||
生产代码尚未初始化。完成 `T-001` 后,将以下目标命令替换为真实可运行命令:
|
||||
|
||||
```powershell
|
||||
python -m venv .venv
|
||||
.\.venv\Scripts\python -m pip install -r requirements.txt
|
||||
.\.venv\Scripts\python manage.py migrate
|
||||
.\.venv\Scripts\python manage.py runserver
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
.venv/bin/pip install -r requirements.txt
|
||||
.venv/bin/python manage.py migrate
|
||||
.venv/bin/python manage.py runserver
|
||||
```
|
||||
|
||||
T-001 完成后,必须同步更新 `init.ps1`、`init.sh`、`03-tech-stack.md`、`05-coding-rules.md` 和 `current-state.md`。
|
||||
`T-001` 完成后,必须同步更新 `init.sh`(`init.ps1` 可选)、`03-tech-stack.md`、`05-coding-rules.md` 和 `current-state.md`。
|
||||
|
||||
Reference in New Issue
Block a user