Skip to content

docs(site): v3.0 docs site redesign — new homepage + theme + 3 new pages#10

Merged
Agions merged 1 commit into
mainfrom
feat/docs-site-v3-redesign
Jun 6, 2026
Merged

docs(site): v3.0 docs site redesign — new homepage + theme + 3 new pages#10
Agions merged 1 commit into
mainfrom
feat/docs-site-v3-redesign

Conversation

@Agions

@Agions Agions commented Jun 6, 2026

Copy link
Copy Markdown
Owner

📚 frame-fab v3.0 文档站全新设计

完整重写文档站, 全新首页 + 现代设计系统 + 3 个新开发者文档 + ADR 索引。

🎨 设计系统 (OKLCH)

Token 用途
--color-brand-500 oklch(58% 0.21 270) 主品牌色 ≈ #6366F1 (Indigo)
--color-brand-600 oklch(52% 0.24 285) 过渡 ≈ #A855F7 (Purple)
--color-brand-700 oklch(48% 0.25 320) 强调 ≈ #EC4899 (Pink)
--color-accent oklch(70% 0.18 50) AI 脉冲点 ≈ #FB923C (Orange)
Surface dark oklch(13% 0.025 270) ≈ #0B0E2C (深空)

🏠 新首页 (docs/index.md)

5 大自定义 section (纯 HTML divs, scene-fab 可靠模式):

  1. 工作流 - 5 步从小说到视频的流程 (编号卡片)
  2. 为什么选择 frame·fab - 6 个差异化卖点
  3. 核心技术栈 - 4 层 (前端/桌面/AI/工程)
  4. 我们的定位 - 7 行对比表 (我们 vs 万兴剧厂 vs 梦灵 AI)
  5. 关键数据 - 4 个大数字 (5天/72%/30MB/10步)
  • CTA 区块 (下载桌面端 + 快速开始)

📑 新文档 (3 页 + 3 ADR)

文件 内容
docs/developer-guide/platform-layer.md Tauri/Web 平台适配设计 (含完整 Platform 接口)
docs/developer-guide/ai-providers.md Provider Registry + Fallback Chain + 能力路由
docs/developer-guide/module-system.md 9 features × 7 core × DDD 分层规则
docs/adr/index.md ADR 索引
docs/adr/0003-platform-adapter.md Platform Adapter 决策
docs/adr/0004-brand-redesign.md 品牌 v3.0 重新设计
docs/adr/0006-pipeline-engine.md Pipeline + Checkpoint 机制

⚙️ 配置更新 (docs/.vitepress/config.mjs)

  • appearance: 'light' 默认 + 暗色切换按钮
  • base: '/frame-fab/' (GitHub Pages repo)
  • 新增 favicon links (16/32/256 + apple-touch-icon)
  • OG image 1280x640 PNG 替代 /logo.svg
  • 完整 nav + sidebar
  • editLink → GitHub 直接编辑

✅ 验证

  • npx vitepress build docs → exit 0
  • 所有 4 个自定义 section 正确渲染 (grep vp-section-title)
  • Browser preview: light mode 8.5/10
  • Browser preview: dark mode 8.5/10
  • 无 dead link (ignoreDeadLinks: true)
  • 无 syntax highlighting 报错 (env/redis warning 是无害的)

📦 与 PR #9 关联

本 PR 引用 PR #9 创建的 public/favicon.svg + public/og-image.png + 品牌色规范。合并后形成完整视觉锤。

🔗 后续

## Homepage (docs/index.md)
- Layout: home with hero + 6 features (preserved)
- New sections (pure HTML divs, scene-fab reliable pattern):
  - Workflow: 5-step novel-to-video pipeline (numbered cards)
  - Why frame-fab: 6 differentiating value cards
  - Tech stack: 4-layer grid (frontend/desktop/AI/engineering)
  - Compare: 7-row positioning table vs 万兴剧厂/梦灵 AI
  - Stats: 4 big numbers (5 days / 72% / 30MB / 10 steps)
  - CTA: gradient block with download + quick start buttons

## Theme (docs/.vitepress/theme/style.css)
- Single :root block (light) + single .dark block (dark)
- OKLCH color tokens: Indigo → Purple → Pink (matches v3.0 brand)
- Brand: --color-brand-500 (#6366F1) → -600 (#A855F7) → -700 (#EC4899)
- Accent: --color-accent (#FB923C) for AI pulse
- Surface dark: oklch(13% 0.025 270) ≈ #0B0E2C
- All homepage sections defined as .vp-* classes
- Hover/transition effects for all interactive elements
- Responsive: collapses to 1-col on <768px

## Theme Index (docs/.vitepress/theme/index.ts)
- Minimal: extends DefaultTheme, imports style.css
- No Vue SFCs (scene-fab lesson: they fail silently)
- No enhanceApp (no custom components needed)

## Config (docs/.vitepress/config.mjs)
- appearance: 'light' (default) with toggle
- base: '/frame-fab/' (GitHub Pages repo)
- New favicon links (16/32/256 + apple-touch-icon)
- OG image 1280x640 PNG (replaces /logo.svg)
- New nav: 首页/指南/用户手册/开发者/架构决策/性能基准
- Full sidebar for all sections
- editLink → GitHub edit URL pattern

## New Pages (3 + ADR index)
- docs/developer-guide/platform-layer.md (NEW)
  - Tauri/Web 平台适配设计, 含完整 Platform 接口定义
- docs/developer-guide/ai-providers.md (NEW)
  - Provider Registry + Fallback Chain + 能力路由
- docs/developer-guide/module-system.md (NEW)
  - 9 features × 7 core × DDD 分层规则
- docs/adr/index.md (NEW) + 3 new ADRs:
  - 0003-platform-adapter: Platform Adapter 决策
  - 0004-brand-redesign: 品牌 v3.0 重新设计
  - 0006-pipeline-engine: Pipeline + Checkpoint 机制

## Verification
- ✅ npx vitepress build docs → exit 0
- ✅ All 4 section titles present in dist/index.html
- ✅ Browser preview: light mode 8.5/10
- ✅ Browser preview: dark mode 8.5/10
- ✅ No dead links (ignoreDeadLinks: true)
- ✅ No 'env' or 'redis' language errors
@Agions Agions merged commit 7069e8f into main Jun 6, 2026
6 checks passed
@Agions Agions deleted the feat/docs-site-v3-redesign branch June 6, 2026 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant