Skip to content

Nuxt Edge Agentic RAG Docs開發者文件中心

面向開發、驗證與維運的正式文件入口,協助開發者快速定位正確來源與操作手冊。

適用對象 ​

  • 第一次接手這個 repo,需要快速建立文件地圖的開發者。
  • 需要部署、驗證、除錯或回溯決策背景的維運與開發人員。
  • 需要查詢規則、規格與治理文件邊界的協作者。

快速開始 ​

  1. 執行 pnpm docs:dev 啟動本機文件站預覽,預設埠號為 4173。
  2. 執行 pnpm docs:build 驗證 VitePress 可正常建置。
  3. 若要模擬正式站點,執行 pnpm docs:preview。
  4. 若你是第一次接手專案,先讀 Onboarding Guide。

建議閱讀順序 ​

第一次接手專案 ​

  1. 先看 開發者文件總覽
  2. 再看 專案結構
  3. 依任務進入 驗證指南、規則入口、規格入口 或 決策紀錄

功能開發前查規則與規格 ​

部署、驗證或故障處理 ​

文件邊界與來源 ​

  • docs/ 是 VitePress 的內容來源,也是 repo 內可直接瀏覽的文件入口。
  • rules/ 與 specs/ 在文件站中提供導覽;實際原始來源分別位於 .claude/rules/、openspec/specs/ 與 openspec/changes/。其中 project-wide instruction 會同步反映到 AGENTS.md 與 CLAUDE.md。
  • verify/、runbooks/、decisions/ 與根目錄治理文件屬於開發者可直接閱讀與維護的正式文件。

維護原則 ​

  • 新增 section index 或調整文件入口時,需同步更新 docs/.vitepress/config.ts 的 nav 與 sidebar。
  • 優先改善導覽與敘述品質,再評估檔名搬動或資料夾重組。
  • 若要 rename 已存在文件,必須先更新 openspec、報告、workflow 與程式碼中的明確引用。

主要入口 ​

Docs powered by VitePress