Skip to content

开发者指南

本地运行文档站

bash
npm install
npm run docs:dev   # http://localhost:5173
npm run docs:build # 构建静态站点到 docs/.vitepress/dist

目录约定

.
├── docs/                       # 文档站点 (VitePress)
│   ├── .vitepress/config.ts    # 站点配置
│   ├── index.md                # 首页
│   ├── overview/               # 产品概览
│   ├── architecture/           # 架构文档 + ADR
│   ├── planning/               # 规划文档 (01-05)
│   └── developer/              # 开发者指南(本目录)
├── github_research.md          # 参考 repo 清单
└── package.json

之后会加入:

├── core/                       # vertical-agnostic Harness 核心 (TBD)
└── verticals/
    └── astock/                 # A 股 instance (TBD)
        ├── tools/              # L3 Tools (Python / JS)
        ├── skills/             # L4 Hermes Skills
        ├── competences/        # L4' Hermes Competences
        └── data/               # L1-L2

添加 ADR

  1. docs/architecture/adr/ 新建 XXXX-标题.md
  2. 用模板:状态 / 日期 / 背景 / 决策 / 理由 / 取舍 / 影响
  3. docs/.vitepress/config.ts sidebar 增加链接

添加规划文档

规划文档在 docs/planning/。修改后直接提交,VitePress 自动 hot reload。

写作约定

  • 中文为主,技术术语保留英文(e.g. "MVP"、"Skill"、"Competence"、"cite")
  • 标点用全角(。,:;)
  • 代码 / 路径 / 命令用 行内代码
  • 避免长 prose,优先列表 / 表格 / 代码块

最后更新:

Internal documentation