mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-13 19:08:05 +00:00
docs: standardize docs readme blocks
This commit is contained in:
+17
-7
@@ -4,13 +4,14 @@
|
||||
|
||||
> `research/` 是新技术、新技术栈、优秀 repo、工程范式和工具趋势的短篇解析与判断笔记。
|
||||
|
||||
## 核心摘要
|
||||
## 字多不看
|
||||
|
||||
- 本目录是“观察与判断区”。
|
||||
- 内容还没有稳定到可以放入 `concepts/` 或 `references/`,但已经值得记录、分析和跟踪。
|
||||
- 本 README 提供稳定锚点和细粒度目录,作为研究笔记的统一入口。
|
||||
- 新技术、新技术栈、优秀 repo 和工程范式,先放这里研究。
|
||||
- 内容稳定后,再沉淀到 `concepts/` 或 `references/`。
|
||||
- 每篇研究笔记先回答:是什么、解决什么问题、是否值得采用、风险在哪里。
|
||||
|
||||
## 总目录
|
||||
## 快速导航
|
||||
|
||||
1. [Harness 工程解析](#research-harness-engineering) - 工程控制、评估器、反馈闭环与 AI 生成系统可靠性。
|
||||
|
||||
@@ -23,16 +24,25 @@
|
||||
|
||||
</details>
|
||||
|
||||
## 和其他目录的边界
|
||||
## 使用方式
|
||||
|
||||
- 用这里记录还在观察期的新技术、repo、工具趋势和工程范式。
|
||||
- 如果内容已经成为稳定概念,迁入 `concepts/`。
|
||||
- 如果内容已经变成可执行清单、模板或选型依据,迁入 `references/`。
|
||||
- 新增研究时同步补充快速导航、完整细粒度目录、`metadata/taxonomy.yml` 和 AI 引用索引。
|
||||
|
||||
## 正文
|
||||
|
||||
### 和其他目录的边界
|
||||
|
||||
- 稳定教程放入 `getting-started/` 或 `references/`。
|
||||
- 核心概念放入 `concepts/`。
|
||||
- 纯哲学模型放入 `philosophy/`。
|
||||
|
||||
## 维护规则
|
||||
### 维护规则
|
||||
|
||||
- 本目录采用“线性总文档”结构,正文统一收敛到 `README.md`。
|
||||
- 新增内容时优先追加到对应大章节,并同步补充总目录或细粒度目录。
|
||||
- 新增内容时优先追加到对应大章节,并同步补充快速导航或完整细粒度目录。
|
||||
- 不再新增同级主题 `.md` 文件;如确需拆分,必须同步更新全仓索引、AGENTS 与 metadata。
|
||||
- 目录内只保留 `README.md` 与 `AGENTS.md`。
|
||||
|
||||
|
||||
Reference in New Issue
Block a user