portal/docs/zh/developer-guide.md
2026-03-15 23:53:12 +08:00

1.2 KiB

开发手册

该仓库以 Web 前端体验为主,文档需要覆盖产品流程、界面边界与集成触点。

本页用于记录本地开发环境、项目结构、测试面与贴合当前代码库的贡献约定。

与当前代码对齐的说明

  • 文档目标仓库: console.svc.plus
  • 仓库类型: frontend
  • 构建与运行依据: package.json (dashboard)
  • 主要实现与运维目录: src/, scripts/, tests/, config/, public/
  • package.json 脚本快照: dev, prebuild, build, build:static, start, lint

需要继续归并的现有文档

  • api/auth.md
  • api/endpoints.md
  • api/errors.md
  • api/overview.md
  • development/code-structure.md
  • development/contributing.md
  • development/dev-setup.md
  • development/testing.md

本页下一步应补充的内容

  • 先描述当前已落地实现,再补充未来规划,避免只写愿景不写现状。
  • 术语需要与仓库根 README、构建清单和实际目录保持一致。
  • 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。
  • 持续让环境搭建与测试命令对应真实存在的脚本、Make 目标或语言工具链。