diff --git a/docs/DOC_COVERAGE.md b/docs/DOC_COVERAGE.md new file mode 100644 index 0000000..3c8e7d4 --- /dev/null +++ b/docs/DOC_COVERAGE.md @@ -0,0 +1,14 @@ +# Documentation Coverage Matrix + +This matrix tracks the bilingual canonical documentation set for `accounts.svc.plus` and maps it back to the current codebase and older docs. + +该矩阵用于跟踪 `accounts.svc.plus` 的双语规范文档，并将其与当前代码状态和历史文档对应起来。 + +| Category | EN | ZH | Current status | Existing references | Next check | +| --- | --- | --- | --- | --- | --- | +| Architecture | Yes | Yes | Seeded from current codebase and existing docs. | `api/overview.md`
`architecture/components.md`
`architecture/design-decisions.md`
`architecture/overview.md`
`architecture/roadmap.md`
`development/code-structure.md` | Keep diagrams and ownership notes synchronized with actual directories, services, and integration dependencies. | +| Design | Yes | Yes | Seeded from current codebase and existing docs. | `architecture/design-decisions.md` | Promote one-off implementation notes into reusable design records when behavior, APIs, or deployment contracts change. | +| Deployment | Yes | Yes | Seeded from current codebase and existing docs. | `Runbook/Feature-Sandbox-Mode-and-Sync-Fix.md`
`Runbook/Fix-Agent-404-And-UUID-Change.md`
`Runbook/Fix-CloudRun-Stunnel-Startup-Failure.md`
`Runbook/Fix-Rotating-UUID-Sync-Archive-2026-02-06.md`
`Runbook/README.md`
`Runbook/Security-Scrubbing-Archive-2026-02-06.md`
`SMTP_GMAIL_SETUP.md`
`development/dev-setup.md` | Verify deployment steps against current scripts, manifests, CI/CD flow, and environment contracts before each release. | +| User Guide | Yes | Yes | Seeded from current codebase and existing docs. | `api/overview.md`
`architecture/overview.md`
`getting-started/concepts.md`
`getting-started/installation.md`
`getting-started/introduction.md`
`getting-started/quickstart.md`
`usage/cli.md`
`usage/config.md` | Prefer workflow-oriented examples and keep screenshots or terminal snippets aligned with the latest UI or CLI behavior. | +| Developer Guide | Yes | Yes | Seeded from current codebase and existing docs. | `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` | Keep setup and test commands tied to actual package scripts, Make targets, or language toolchains in this repository. | +| Vibe Coding Reference | Yes | Yes | Seeded from current codebase and existing docs. | `Runbook/Fix-Agent-404-And-UUID-Change.md`
`api/auth.md`
`api/endpoints.md`
`api/errors.md`
`api/overview.md` | Review prompt templates and repo rules whenever the project adds new subsystems, protected areas, or mandatory verification steps. | diff --git a/docs/README.md b/docs/README.md index 842c4fa..df4104b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,26 +1,42 @@ -# XControl Account Service 文档 +# Accounts Service Plus / 账号与身份服务 -本文档集覆盖 `accounts.svc.plus` 账号服务的安装、配置、使用、架构、运维与贡献指南。内容基于当前代码与配置模板整理，便于在不同环境快速落地。 +This `docs/` directory now has a bilingual canonical layer for the current repository state. -## 快速入口 +本 `docs/` 目录现已补齐双语规范层，用于承接当前仓库状态下的核心文档。 -- 新手：`getting-started/introduction.md`、`getting-started/quickstart.md` -- 架构：`architecture/overview.md`、`architecture/components.md` -- 配置与使用：`usage/config.md`、`usage/deployment.md`、`usage/examples.md` -- API：`api/overview.md`、`api/endpoints.md`、`api/errors.md` -- 运维：`operations/monitoring.md`、`operations/troubleshooting.md` +## Quick Entry / 快速入口 -## 文档结构 +- Coverage checklist / 覆盖检查矩阵: `docs/DOC_COVERAGE.md` +- English index / 英文入口: `docs/en/README.md` +- 中文入口 / Chinese index: `docs/zh/README.md` -- `getting-started/`：10 分钟跑起来 -- `architecture/`：Why > How 的架构说明 -- `usage/`：如何配置与使用 -- `api/`：接口说明与错误约定 -- `integrations/`：数据库、云、邮件与第三方对接 -- `advanced/`：性能、安全、扩展 -- `development/`：开发与贡献 -- `operations/`：监控、日志、备份与排障 -- `governance/`：许可证与发布流程 -- `appendix/`：FAQ、术语表与参考资料 +## Canonical Bilingual Pages / 双语规范页 -> 备注：仓库内已有 `docs/SMTP_GMAIL_SETUP.md`（Cloud Run + Gmail SMTP），在 `integrations/cloud.md` 中有交叉引用。 +- `docs/en/architecture.md` / `docs/zh/architecture.md` +- `docs/en/design.md` / `docs/zh/design.md` +- `docs/en/deployment.md` / `docs/zh/deployment.md` +- `docs/en/user-guide.md` / `docs/zh/user-guide.md` +- `docs/en/developer-guide.md` / `docs/zh/developer-guide.md` +- `docs/en/vibe-coding-reference.md` / `docs/zh/vibe-coding-reference.md` + +## Current Repo Context / 当前仓库背景 + +- Root README: `accounts.svc.plus` +- Previous docs index: `XControl Account Service 文档` +- Manifest evidence / 构建清单: go.mod (`account`) +- Active code and ops directories / 当前主要目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` + +## Existing Docs To Reconcile / 需要继续归并的现有文档 + +- `Runbook/Feature-Sandbox-Mode-and-Sync-Fix.md` +- `Runbook/Fix-Agent-404-And-UUID-Change.md` +- `Runbook/Fix-CloudRun-Stunnel-Startup-Failure.md` +- `Runbook/Fix-Rotating-UUID-Sync-Archive-2026-02-06.md` +- `Runbook/README.md` +- `Runbook/Security-Scrubbing-Archive-2026-02-06.md` +- `SMTP_GMAIL_SETUP.md` +- `advanced/customization.md` +- `advanced/performance.md` +- `advanced/scalability.md` +- `advanced/security.md` +- `api/auth.md` diff --git a/docs/en/README.md b/docs/en/README.md new file mode 100644 index 0000000..b4031ff --- /dev/null +++ b/docs/en/README.md @@ -0,0 +1,34 @@ +# Accounts Service Plus Documentation + +This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities. + +## Current state snapshot + +- Root README title: `accounts.svc.plus` +- Build/runtime evidence: go.mod (`account`) +- Primary directories detected: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- Existing docs count: 44 + +## Canonical pages + +- [Architecture](architecture.md) +- [Design](design.md) +- [Deployment](deployment.md) +- [User Guide](user-guide.md) +- [Developer Guide](developer-guide.md) +- [Vibe Coding Reference](vibe-coding-reference.md) + +## Legacy docs to fold in + +- `Runbook/Feature-Sandbox-Mode-and-Sync-Fix.md` +- `Runbook/Fix-Agent-404-And-UUID-Change.md` +- `Runbook/Fix-CloudRun-Stunnel-Startup-Failure.md` +- `Runbook/Fix-Rotating-UUID-Sync-Archive-2026-02-06.md` +- `Runbook/README.md` +- `Runbook/Security-Scrubbing-Archive-2026-02-06.md` +- `SMTP_GMAIL_SETUP.md` +- `advanced/customization.md` +- `advanced/performance.md` +- `advanced/scalability.md` +- `advanced/security.md` +- `api/auth.md` diff --git a/docs/en/architecture.md b/docs/en/architecture.md new file mode 100644 index 0000000..c98f273 --- /dev/null +++ b/docs/en/architecture.md @@ -0,0 +1,29 @@ +# Architecture + +This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities. + +Use this page as the canonical bilingual overview of system boundaries, major components, and repo ownership. + +## Current code-aligned notes + +- Documentation target: `accounts.svc.plus` +- Repo kind: `go-service` +- Manifest and build evidence: go.mod (`account`) +- Primary implementation and ops directories: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- Package scripts snapshot: No package.json scripts were detected. + +## Existing docs to reconcile + +- `api/overview.md` +- `architecture/components.md` +- `architecture/design-decisions.md` +- `architecture/overview.md` +- `architecture/roadmap.md` +- `development/code-structure.md` + +## What this page should cover next + +- Describe the current implementation rather than an aspirational future-only design. +- Keep terminology aligned with the repository root README, manifests, and actual directories. +- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above. +- Keep diagrams and ownership notes synchronized with actual directories, services, and integration dependencies. diff --git a/docs/en/deployment.md b/docs/en/deployment.md new file mode 100644 index 0000000..0850ee3 --- /dev/null +++ b/docs/en/deployment.md @@ -0,0 +1,31 @@ +# Deployment + +This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities. + +Use this page to standardize deployment prerequisites, supported topologies, operational checks, and rollback notes. + +## Current code-aligned notes + +- Documentation target: `accounts.svc.plus` +- Repo kind: `go-service` +- Manifest and build evidence: go.mod (`account`) +- Primary implementation and ops directories: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- Package scripts snapshot: No package.json scripts were detected. + +## Existing docs to reconcile + +- `Runbook/Feature-Sandbox-Mode-and-Sync-Fix.md` +- `Runbook/Fix-Agent-404-And-UUID-Change.md` +- `Runbook/Fix-CloudRun-Stunnel-Startup-Failure.md` +- `Runbook/Fix-Rotating-UUID-Sync-Archive-2026-02-06.md` +- `Runbook/README.md` +- `Runbook/Security-Scrubbing-Archive-2026-02-06.md` +- `SMTP_GMAIL_SETUP.md` +- `development/dev-setup.md` + +## What this page should cover next + +- Describe the current implementation rather than an aspirational future-only design. +- Keep terminology aligned with the repository root README, manifests, and actual directories. +- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above. +- Verify deployment steps against current scripts, manifests, CI/CD flow, and environment contracts before each release. diff --git a/docs/en/design.md b/docs/en/design.md new file mode 100644 index 0000000..b2620d4 --- /dev/null +++ b/docs/en/design.md @@ -0,0 +1,24 @@ +# Design + +This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities. + +Use this page to consolidate design decisions, ADR-style tradeoffs, and roadmap-sensitive implementation notes. + +## Current code-aligned notes + +- Documentation target: `accounts.svc.plus` +- Repo kind: `go-service` +- Manifest and build evidence: go.mod (`account`) +- Primary implementation and ops directories: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- Package scripts snapshot: No package.json scripts were detected. + +## Existing docs to reconcile + +- `architecture/design-decisions.md` + +## What this page should cover next + +- Describe the current implementation rather than an aspirational future-only design. +- Keep terminology aligned with the repository root README, manifests, and actual directories. +- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above. +- Promote one-off implementation notes into reusable design records when behavior, APIs, or deployment contracts change. diff --git a/docs/en/developer-guide.md b/docs/en/developer-guide.md new file mode 100644 index 0000000..251bc02 --- /dev/null +++ b/docs/en/developer-guide.md @@ -0,0 +1,31 @@ +# Developer Guide + +This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities. + +Use this page to document local setup, project structure, test surfaces, and contribution conventions tied to the current codebase. + +## Current code-aligned notes + +- Documentation target: `accounts.svc.plus` +- Repo kind: `go-service` +- Manifest and build evidence: go.mod (`account`) +- Primary implementation and ops directories: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- Package scripts snapshot: No package.json scripts were detected. + +## Existing docs to reconcile + +- `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` + +## What this page should cover next + +- Describe the current implementation rather than an aspirational future-only design. +- Keep terminology aligned with the repository root README, manifests, and actual directories. +- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above. +- Keep setup and test commands tied to actual package scripts, Make targets, or language toolchains in this repository. diff --git a/docs/en/user-guide.md b/docs/en/user-guide.md new file mode 100644 index 0000000..72f8be9 --- /dev/null +++ b/docs/en/user-guide.md @@ -0,0 +1,31 @@ +# User Guide + +This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities. + +Use this page to document primary user/operator tasks, everyday workflows, and navigation to existing how-to material. + +## Current code-aligned notes + +- Documentation target: `accounts.svc.plus` +- Repo kind: `go-service` +- Manifest and build evidence: go.mod (`account`) +- Primary implementation and ops directories: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- Package scripts snapshot: No package.json scripts were detected. + +## Existing docs to reconcile + +- `api/overview.md` +- `architecture/overview.md` +- `getting-started/concepts.md` +- `getting-started/installation.md` +- `getting-started/introduction.md` +- `getting-started/quickstart.md` +- `usage/cli.md` +- `usage/config.md` + +## What this page should cover next + +- Describe the current implementation rather than an aspirational future-only design. +- Keep terminology aligned with the repository root README, manifests, and actual directories. +- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above. +- Prefer workflow-oriented examples and keep screenshots or terminal snippets aligned with the latest UI or CLI behavior. diff --git a/docs/en/vibe-coding-reference.md b/docs/en/vibe-coding-reference.md new file mode 100644 index 0000000..916430c --- /dev/null +++ b/docs/en/vibe-coding-reference.md @@ -0,0 +1,28 @@ +# Vibe Coding Reference + +This repository is a Go service with API, configuration, runtime operations, and deployment responsibilities. + +Use this page to align AI-assisted coding prompts, repo boundaries, safe edit rules, and documentation update expectations. + +## Current code-aligned notes + +- Documentation target: `accounts.svc.plus` +- Repo kind: `go-service` +- Manifest and build evidence: go.mod (`account`) +- Primary implementation and ops directories: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- Package scripts snapshot: No package.json scripts were detected. + +## Existing docs to reconcile + +- `Runbook/Fix-Agent-404-And-UUID-Change.md` +- `api/auth.md` +- `api/endpoints.md` +- `api/errors.md` +- `api/overview.md` + +## What this page should cover next + +- Describe the current implementation rather than an aspirational future-only design. +- Keep terminology aligned with the repository root README, manifests, and actual directories. +- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above. +- Review prompt templates and repo rules whenever the project adds new subsystems, protected areas, or mandatory verification steps. diff --git a/docs/zh/README.md b/docs/zh/README.md new file mode 100644 index 0000000..4f1cba6 --- /dev/null +++ b/docs/zh/README.md @@ -0,0 +1,34 @@ +# 账号与身份服务 文档 + +该仓库是 Go 服务，文档需要覆盖 API、配置、运行时操作与部署职责。 + +## 当前状态快照 + +- 根 README 标题: `accounts.svc.plus` +- 构建与运行时证据: go.mod (`account`) +- 自动识别的主要目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- 现有文档数量: 44 + +## 核心双语文档 + +- [架构](architecture.md) +- [设计](design.md) +- [部署](deployment.md) +- [使用手册](user-guide.md) +- [开发手册](developer-guide.md) +- [Vibe Coding 参考](vibe-coding-reference.md) + +## 待归并的历史文档 + +- `Runbook/Feature-Sandbox-Mode-and-Sync-Fix.md` +- `Runbook/Fix-Agent-404-And-UUID-Change.md` +- `Runbook/Fix-CloudRun-Stunnel-Startup-Failure.md` +- `Runbook/Fix-Rotating-UUID-Sync-Archive-2026-02-06.md` +- `Runbook/README.md` +- `Runbook/Security-Scrubbing-Archive-2026-02-06.md` +- `SMTP_GMAIL_SETUP.md` +- `advanced/customization.md` +- `advanced/performance.md` +- `advanced/scalability.md` +- `advanced/security.md` +- `api/auth.md` diff --git a/docs/zh/architecture.md b/docs/zh/architecture.md new file mode 100644 index 0000000..aeb3397 --- /dev/null +++ b/docs/zh/architecture.md @@ -0,0 +1,29 @@ +# 架构 + +该仓库是 Go 服务，文档需要覆盖 API、配置、运行时操作与部署职责。 + +本页作为系统边界、核心组件与仓库职责的双语总览入口。 + +## 与当前代码对齐的说明 + +- 文档目标仓库: `accounts.svc.plus` +- 仓库类型: `go-service` +- 构建与运行依据: go.mod (`account`) +- 主要实现与运维目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- `package.json` 脚本快照: No package.json scripts were detected. + +## 需要继续归并的现有文档 + +- `api/overview.md` +- `architecture/components.md` +- `architecture/design-decisions.md` +- `architecture/overview.md` +- `architecture/roadmap.md` +- `development/code-structure.md` + +## 本页下一步应补充的内容 + +- 先描述当前已落地实现，再补充未来规划，避免只写愿景不写现状。 +- 术语需要与仓库根 README、构建清单和实际目录保持一致。 +- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。 +- 随着目录结构、服务关系和集成依赖变化，持续同步图示与职责说明。 diff --git a/docs/zh/deployment.md b/docs/zh/deployment.md new file mode 100644 index 0000000..1983cd4 --- /dev/null +++ b/docs/zh/deployment.md @@ -0,0 +1,31 @@ +# 部署 + +该仓库是 Go 服务，文档需要覆盖 API、配置、运行时操作与部署职责。 + +本页用于统一部署前提、支持的拓扑、运维检查项与回滚注意事项。 + +## 与当前代码对齐的说明 + +- 文档目标仓库: `accounts.svc.plus` +- 仓库类型: `go-service` +- 构建与运行依据: go.mod (`account`) +- 主要实现与运维目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- `package.json` 脚本快照: No package.json scripts were detected. + +## 需要继续归并的现有文档 + +- `Runbook/Feature-Sandbox-Mode-and-Sync-Fix.md` +- `Runbook/Fix-Agent-404-And-UUID-Change.md` +- `Runbook/Fix-CloudRun-Stunnel-Startup-Failure.md` +- `Runbook/Fix-Rotating-UUID-Sync-Archive-2026-02-06.md` +- `Runbook/README.md` +- `Runbook/Security-Scrubbing-Archive-2026-02-06.md` +- `SMTP_GMAIL_SETUP.md` +- `development/dev-setup.md` + +## 本页下一步应补充的内容 + +- 先描述当前已落地实现，再补充未来规划，避免只写愿景不写现状。 +- 术语需要与仓库根 README、构建清单和实际目录保持一致。 +- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。 +- 每次发布前，依据当前脚本、清单、CI/CD 流程和环境契约重新核对部署步骤。 diff --git a/docs/zh/design.md b/docs/zh/design.md new file mode 100644 index 0000000..6075f08 --- /dev/null +++ b/docs/zh/design.md @@ -0,0 +1,24 @@ +# 设计 + +该仓库是 Go 服务，文档需要覆盖 API、配置、运行时操作与部署职责。 + +本页用于汇总设计决策、类似 ADR 的权衡记录，以及与路线图相关的实现说明。 + +## 与当前代码对齐的说明 + +- 文档目标仓库: `accounts.svc.plus` +- 仓库类型: `go-service` +- 构建与运行依据: go.mod (`account`) +- 主要实现与运维目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- `package.json` 脚本快照: No package.json scripts were detected. + +## 需要继续归并的现有文档 + +- `architecture/design-decisions.md` + +## 本页下一步应补充的内容 + +- 先描述当前已落地实现，再补充未来规划，避免只写愿景不写现状。 +- 术语需要与仓库根 README、构建清单和实际目录保持一致。 +- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。 +- 当行为、API 或部署契约发生变化时，把一次性实现笔记提升为可复用设计记录。 diff --git a/docs/zh/developer-guide.md b/docs/zh/developer-guide.md new file mode 100644 index 0000000..be77a99 --- /dev/null +++ b/docs/zh/developer-guide.md @@ -0,0 +1,31 @@ +# 开发手册 + +该仓库是 Go 服务，文档需要覆盖 API、配置、运行时操作与部署职责。 + +本页用于记录本地开发环境、项目结构、测试面与贴合当前代码库的贡献约定。 + +## 与当前代码对齐的说明 + +- 文档目标仓库: `accounts.svc.plus` +- 仓库类型: `go-service` +- 构建与运行依据: go.mod (`account`) +- 主要实现与运维目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- `package.json` 脚本快照: No package.json scripts were detected. + +## 需要继续归并的现有文档 + +- `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 目标或语言工具链。 diff --git a/docs/zh/user-guide.md b/docs/zh/user-guide.md new file mode 100644 index 0000000..2f43c72 --- /dev/null +++ b/docs/zh/user-guide.md @@ -0,0 +1,31 @@ +# 使用手册 + +该仓库是 Go 服务，文档需要覆盖 API、配置、运行时操作与部署职责。 + +本页用于记录主要用户或运维角色的日常任务、常见流程，以及现有操作文档入口。 + +## 与当前代码对齐的说明 + +- 文档目标仓库: `accounts.svc.plus` +- 仓库类型: `go-service` +- 构建与运行依据: go.mod (`account`) +- 主要实现与运维目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- `package.json` 脚本快照: No package.json scripts were detected. + +## 需要继续归并的现有文档 + +- `api/overview.md` +- `architecture/overview.md` +- `getting-started/concepts.md` +- `getting-started/installation.md` +- `getting-started/introduction.md` +- `getting-started/quickstart.md` +- `usage/cli.md` +- `usage/config.md` + +## 本页下一步应补充的内容 + +- 先描述当前已落地实现，再补充未来规划，避免只写愿景不写现状。 +- 术语需要与仓库根 README、构建清单和实际目录保持一致。 +- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。 +- 优先提供面向流程的示例，并确保截图或终端片段与最新 UI/CLI 行为一致。 diff --git a/docs/zh/vibe-coding-reference.md b/docs/zh/vibe-coding-reference.md new file mode 100644 index 0000000..bad1e95 --- /dev/null +++ b/docs/zh/vibe-coding-reference.md @@ -0,0 +1,28 @@ +# Vibe Coding 参考 + +该仓库是 Go 服务，文档需要覆盖 API、配置、运行时操作与部署职责。 + +本页用于统一 AI 辅助开发提示词、仓库边界、安全编辑规则与文档同步要求。 + +## 与当前代码对齐的说明 + +- 文档目标仓库: `accounts.svc.plus` +- 仓库类型: `go-service` +- 构建与运行依据: go.mod (`account`) +- 主要实现与运维目录: `cmd/`, `internal/`, `api/`, `accountsvc/`, `deploy/`, `ansible/`, `scripts/`, `tests/`, `sql/`, `config/` +- `package.json` 脚本快照: No package.json scripts were detected. + +## 需要继续归并的现有文档 + +- `Runbook/Fix-Agent-404-And-UUID-Change.md` +- `api/auth.md` +- `api/endpoints.md` +- `api/errors.md` +- `api/overview.md` + +## 本页下一步应补充的内容 + +- 先描述当前已落地实现，再补充未来规划，避免只写愿景不写现状。 +- 术语需要与仓库根 README、构建清单和实际目录保持一致。 +- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。 +- 当项目新增子系统、受保护目录或强制验证步骤时，同步更新提示模板与仓库规则。