Initial AI Coding docs site

Author: wutongci

.github/workflows/pages.yml

@@ -0,0 +1,42 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+        env:
+          VITEPRESS_BASE: /aicoding/
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+docs/.vitepress/cache/
+docs/.vitepress/dist/
+docs/public/markdown/
+.DS_Store
+!package-lock.json

README.md

@@ -0,0 +1,29 @@
+# AI Coding
+
+AI Coding 是一个面向 AI-native 软件工程的知识站，目标是把“AI 会写代码”升级成“团队能稳定交付软件”。
+
+站点覆盖：
+
+- AI Coding 心智模型与成熟度模型
+- PRD、任务切片、上下文工程、实现循环
+- Harness Engine：MCP、工具生态、Workflow Graph、安全、编排、多 Agent、人类门
+- AI-native 验收：Reviewer Swarm、Test Skeptic、安全红队、证据包、人类裁决
+- 架构治理、测试策略、安全、发布、可维护性
+- 团队角色、指标、工具选型
+- Prompt 模板、Reviewer JSON 契约、检查清单
+- 附录阅读笔记：Claude Code Best Practices、OpenAI Building Agents、LangChain Harness 分层等外部资料映射
+
+## 本地开发
+
+```bash
+npm install
+npm run dev
+```
+
+## 构建
+
+```bash
+npm run build
+```
+
+静态站点输出到 `docs/.vitepress/dist`。GitHub Pages workflow 会在构建时设置 `VITEPRESS_BASE=/aicoding/`。

docs/.vitepress/config.ts

@@ -0,0 +1,144 @@
+import { defineConfig } from 'vitepress'
+
+const base = process.env.VITEPRESS_BASE || '/'
+
+const nav = [
+  { text: '起步', link: '/guide/why-ai-coding' },
+  { text: '工作流', link: '/workflow/overview' },
+  { text: 'Harness', link: '/harness/overview' },
+  { text: '验收', link: '/acceptance/ai-native-acceptance' },
+  { text: '质量', link: '/quality/architecture' },
+  { text: '团队', link: '/team/operating-model' },
+  { text: '模板', link: '/reference/prompt-library' },
+  { text: '附录', link: '/appendix/claude-code-best-practices' },
+  { text: 'GitHub', link: 'https://github.com/limecloud/aicoding' }
+]
+
+const sidebar = [
+  {
+    text: '起步',
+    items: [
+      { text: '总览', link: '/' },
+      { text: '为什么需要 AI Coding 体系', link: '/guide/why-ai-coding' },
+      { text: 'AI Coding 操作系统', link: '/guide/operating-system' },
+      { text: '成熟度模型', link: '/guide/maturity-model' }
+    ]
+  },
+  {
+    text: '工作流',
+    items: [
+      { text: '全流程地图', link: '/workflow/overview' },
+      { text: '需求与任务切片', link: '/workflow/prd-and-slicing' },
+      { text: '上下文工程', link: '/workflow/context-engineering' },
+      { text: '实现循环', link: '/workflow/implementation-loop' },
+      { text: '人机协作协议', link: '/workflow/handoff-protocol' }
+    ]
+  },
+  {
+    text: 'Harness Engine',
+    items: [
+      { text: 'Harness 总览', link: '/harness/overview' },
+      { text: '业界模式整理', link: '/harness/industry-patterns' },
+      { text: 'AI Coding Harness 蓝图', link: '/harness/ai-coding-harness' }
+    ]
+  },
+  {
+    text: 'AI-Native 验收',
+    items: [
+      { text: '验收总览', link: '/acceptance/ai-native-acceptance' },
+      { text: 'Reviewer Swarm', link: '/acceptance/reviewer-swarm' },
+      { text: '测试审查', link: '/acceptance/test-skeptic' },
+      { text: '安全红队', link: '/acceptance/security-red-team' },
+      { text: '证据包与人类裁决', link: '/acceptance/evidence-and-human-arbiter' }
+    ]
+  },
+  {
+    text: '工程质量',
+    items: [
+      { text: '架构与治理', link: '/quality/architecture' },
+      { text: '测试策略', link: '/quality/testing-strategy' },
+      { text: '安全与权限', link: '/quality/security' },
+      { text: '发布、灰度与回滚', link: '/quality/release' },
+      { text: '可维护性', link: '/quality/maintainability' }
+    ]
+  },
+  {
+    text: '团队落地',
+    items: [
+      { text: '组织运行模型', link: '/team/operating-model' },
+      { text: '角色与职责', link: '/team/roles' },
+      { text: '度量指标', link: '/team/metrics' },
+      { text: '工具选型', link: '/team/tooling' }
+    ]
+  },
+  {
+    text: '参考',
+    items: [
+      { text: 'Prompt 模板库', link: '/reference/prompt-library' },
+      { text: 'AI Reviewer JSON 契约', link: '/reference/reviewer-contract' },
+      { text: '检查清单', link: '/reference/checklists' },
+      { text: '术语表', link: '/reference/glossary' }
+    ]
+  },
+  {
+    text: '附录',
+    items: [
+      { text: 'Harness 阅读地图', link: '/appendix/harness-reading-map' },
+      { text: 'Claude Code Best Practices 导读', link: '/appendix/claude-code-best-practices' },
+      { text: 'OpenAI Building Agents 导读', link: '/appendix/openai-building-agents-guide' },
+      { text: 'LangChain Harness 分层导读', link: '/appendix/langchain-framework-runtime-harness' }
+    ]
+  }
+]
+
+export default defineConfig({
+  base,
+  title: 'AI Coding',
+  description: '面向 AI-native 软件工程的全流程知识站。',
+  cleanUrls: true,
+  lastUpdated: true,
+  metaChunk: true,
+  head: [
+    ['link', { rel: 'icon', href: `${base}favicon.svg` }],
+    ['meta', { name: 'theme-color', content: '#0f2f3d' }],
+    ['meta', { property: 'og:title', content: 'AI Coding' }],
+    ['meta', { property: 'og:description', content: '面向 AI-native 软件工程的全流程知识站。' }]
+  ],
+  themeConfig: {
+    logo: '/favicon.svg',
+    siteTitle: 'AI Coding',
+    nav,
+    sidebar,
+    search: { provider: 'local' },
+    editLink: {
+      pattern: 'https://github.com/limecloud/aicoding/edit/main/docs/:path',
+      text: '在 GitHub 编辑本页'
+    },
+    footer: {
+      message: 'AI-native software engineering playbook for teams that ship with coding agents.',
+      copyright: 'Released for discussion and implementation.'
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/limecloud/aicoding' }
+    ]
+  },
+  markdown: {
+    lineNumbers: true,
+    config(md) {
+      const defaultFence = md.renderer.rules.fence
+      md.renderer.rules.fence = (tokens, idx, options, env, self) => {
+        const token = tokens[idx]
+        const language = token.info.trim().split(/\s+/)[0]
+
+        if (language === 'mermaid') {
+          const encoded = encodeURIComponent(token.content)
+          return `<ClientOnly><MermaidDiagram code="${encoded}" /></ClientOnly>`
+        }
+
+        return defaultFence
+          ? defaultFence(tokens, idx, options, env, self)
+          : self.renderToken(tokens, idx, options)
+      }
+    }
+  }
+})

docs/.vitepress/theme/MermaidDiagram.vue

@@ -0,0 +1,48 @@
+<script setup lang="ts">
+import { computed, onMounted, ref, watch } from 'vue'
+import { useData } from 'vitepress'
+
+const props = defineProps<{
+  code: string
+}>()
+
+const { isDark } = useData()
+const source = computed(() => decodeURIComponent(props.code))
+const svg = ref('')
+const error = ref('')
+let renderCount = 0
+
+async function renderDiagram() {
+  if (typeof window === 'undefined') return
+
+  try {
+    error.value = ''
+    const mermaid = (await import('mermaid')).default
+    mermaid.initialize({
+      startOnLoad: false,
+      securityLevel: 'strict',
+      theme: isDark.value ? 'dark' : 'default'
+    })
+
+    renderCount += 1
+    const id = `ai-coding-mermaid-${Date.now()}-${renderCount}`
+    const result = await mermaid.render(id, source.value)
+    svg.value = result.svg
+  } catch (reason) {
+    svg.value = ''
+    error.value = reason instanceof Error ? reason.message : String(reason)
+  }
+}
+
+onMounted(renderDiagram)
+watch(() => props.code, renderDiagram)
+watch(isDark, renderDiagram)
+</script>
+
+<template>
+  <figure class="ac-mermaid">
+    <div v-if="svg" class="ac-mermaid__canvas" v-html="svg" />
+    <pre v-else class="ac-mermaid__fallback"><code>{{ source }}</code></pre>
+    <figcaption v-if="error" class="ac-mermaid__error">Mermaid render failed: {{ error }}</figcaption>
+  </figure>
+</template>