跳至主要内容

Source Index

這頁承接原本 docs/README.md 的 taxonomy:Markdown 仍是 source of truth,Dev Portal 只把入口整理得更容易掃描。

Directory taxonomy

位置用途命名
docs/目前仍有效的架構、API、政策、設計文件,或仍在進行中的 plan/proposal<topic>.md
docs/dev-portal/Dev Portal 導覽頁:onboarding、domain map、flow、source index、graph explorer<topic>.md
docs/history/已完成的一次性遷移、盤點、整理或決策紀錄YYYY-MM-DD-<topic>.md
docs/ai/既有 AI 協作指南與 agent-facing 文件<topic>.md
docs/superpowers/specs/已確認或待確認的設計規格;proposal 不得自動視為 implementation source of truthYYYY-MM-DD-<topic>-design.md
docs/superpowers/plans/實作前計畫與完成後的執行紀錄YYYY-MM-DD-<feature>.md
plans/repo 既有工作計畫或執行紀錄<feature-slug>.md

Root source of truth

文件定位
architecture.md系統整體架構與主要資料流
auth-architecture.mdAuth 現況與 migration guardrails
backend-permissions.mdBackend role / permission 現況與變更 guardrails
auto-merge-policy.mdAuto-merge 與 approve 語義
dependabot-update-policy.mdDependabot 更新政策
draft-pr-auto-ready.mdDraft PR auto-ready 現行流程
pr-scope-policy.mdPR scope 與 required checks policy
sequence-diagram.mdWatch / points / dashboard 主要時序圖
tokenomics.md$TACHI 平台幣經濟模型
uuid-v7.mdUUID 版本策略
watch-to-points-design.mdWatch-to-points 已完成設計

Active plans / proposals

文件定位
atlas-migration-plan.md#463 Atlas migration 拆分實作計畫;不得單獨視為已完成狀態
atlas-schema-reconciliation.md#463 baseline 前 schema reconciliation evidence / procedure
non-web3-launch-readiness.md暫時捨棄 Web3 上鏈部分後的上線距離、Codex 自動化能力與真人介入層級 snapshot
openapi-codegen-flow.md#401 OpenAPI → TypeScript contracts / codegen rollout 計畫
tachigo Dev Portal spec#674 Dev Portal 設計規格;命名已避開 atlasgo tooling 混淆

Root reference / discussion notes

文件定位
extension-ui-prompts.mdTachimint UI prompt reference,不是產品 runtime source of truth
feature-discussion.md早期產品討論紀錄;仍保留供背景參考,不得單獨視為 implementation source of truth
tachimint-loyalty-claim-boundary.mdTachimint / claim flow 邊界討論短文件,不是正式 architecture source of truth

Dev Portal operations

文件定位
deployment.mdCloudflare Pages 手動連 repo、branch deploy / PR preview、公開 URL 驗證與 rollback/readback checklist

Code source map

AreaSource
API bootstrap / routercmd/server, internal/router/router.go
API handlersservices/api/internal/handlers
API servicesservices/api/internal/services
API models / migrationsservices/api/internal/models, services/api/migrations
Extension appapps/extension/src
Dashboard appapps/dashboard/src
Shared generated typespackages/shared-types
API client packagepackages/api-client
Docs portalapps/docs, docs/dev-portal

Naming rules

  • 目前仍是 source of truth 的文件不加日期,例如 architecture.mdtokenomics.md
  • 歷史紀錄與決策紀錄使用日期開頭,例如 2026-04-30-monorepo-directory-refactor.md
  • Proposal 不能在未採納前寫成完成狀態;Dev Portal 只連到它,並標註狀態。
  • 可見名稱、sidebar label、slug 與目錄使用 tachigo Dev Portal / Dev Portal,不要把導覽網站命名成 Atlas,以免和 atlasgo migration tooling 混淆。