跳轉到

專案概覽

定位

ekkorn-doc 是 Ekkorn 工程團隊的 Docs-as-Code 中樞，扮演兩個核心角色：

  1. 全域 AI 規範的 Source of Truth — 集中管理 CLAUDE.md、GEMINI.md 及共用 AI Skills，透過 deploy-config.sh 部署至各開發者的本地工作目錄
  2. 跨 repo 文件聚合站 — CI/CD 自動從 23 個 repo 拉取 docs/，合併編譯為 MkDocs Material 靜態網站

在 Ekkorn 生態圈中的角色

各 repo (app-server, want-payment, ...)
  └── docs/          ← 各自維護的專案文件
        │
        ▼  (sync-docs.sh, GitHub Actions)
ekkorn-doc
  ├── workspace/     ← 全域規範 Source of Truth
  │     └── deploy-config.sh → $EKKORN_WORK_DIR/
  └── site/docs/     ← 聚合所有 repo 的 docs/
        │
        ▼  (mkdocs build)
  靜態網站 (Cloudflare Pages, Stage 2)

ekkorn-doc 不包含任何業務邏輯程式碼，純粹負責文件治理與發佈。

Repo 清單管理

所有需要同步文件的 repo 定義在 scripts/repos.yml，格式：

repos:
  - name: app-server          # 顯示名稱 & site/docs/ 下的子目錄名
    github: SHOW-YOU-APP/app-server  # GitHub repo 路徑
    docs_path: docs            # repo 中文件目錄的路徑
    branch: master             # 預設拉取的分支

新增 repo 只需在 repos.yml 加一筆記錄，下次 CI 執行時自動同步。

目前涵蓋的 repo（23 個）

依分類：

  • 核心後端：app-server, want-payment, cron-worker, notification-worker, room-keeper, showyou-heartbeat-server, showyou-tracking, event-log-common, trtc_callback_server
  • 數據統計：stat-cal, tier-cal, tag-data-refresher, data-echo-etl-infra, gift-rank-data
  • 前端行動端：ekkorn-web, showyou-h5, ekkorn-android, ekkorn-ios
  • 管理後台：showyou-admin, showyou-ry-admin
  • 基礎設施：gitops-infra, devops-snippets, ekkorn-sql

詳細說明見全域 workspace/docs/repo_overview.md。