WorkBuddyGuide

⚠ 该项目 README 未提供完整安装说明，以下步骤为通用流程，请以官方文档为准。

环境要求

• 能访问 GitHub 仓库与 workbuddy.homes 在线站点
• 本地已安装 Git（用于克隆仓库）
• 若要自行部署文档站：需要 GitHub 账号与 Cloudflare 账号（Cloudflare Pages）

安装与启动步骤

1. 1在线阅读蓝皮书

   推荐直接访问官网阅读，网站提供侧边栏、全文搜索、章节目录、深色模式和移动端适配，体验比 GitHub 更完整。

2. 2克隆仓库

   GitHub 适合了解项目结构、查阅源码文档与参与贡献。克隆后所有章节内容都在 docs 目录下。

   git clone https://github.com/AlephAITech/WorkBuddyGuide.git

   复制

3. 3看阅读路线

   先读阅读指南，确定自己是按顺序读第一篇，还是直接跳到第二篇对应案例。

   cat "docs/reading-guide.md"

   复制

4. 4从第一章开始

   第一次使用请从第 1 章《初识 WorkBuddy》起步，按顺序完成第一篇使用手册。

   cat "docs/bluebook/第一篇 使用手册：先把 WorkBuddy 用起来/第 1 章 初识 WorkBuddy/index.md"

   复制

5. 5查看部署配置

   文档站基于 VitePress + Cloudflare Pages + GitHub 构建，具体配置说明见仓库根目录的 DEPLOYMENT.md。

   cat DEPLOYMENT.md

   复制

6. 6接入自动部署

   在 Cloudflare Pages 中连接本仓库的 main 分支，之后每次推送都会自动构建部署，无需手动操作。

关键配置

如何确认成功

浏览器打开 https://workbuddy.homes/ 能正常看到蓝皮书站点与章节导航；自建部署后向 main 分支推送应触发 Cloudflare Pages 自动构建成功。

常见问题

注意事项

• 本项目本质是一份实战指南（文档内容），并非可直接运行的软件包，README 中未提供安装依赖、启动服务等命令。
• 阅读顺序建议：新手顺序读完第一篇；已有具体任务直接进第二篇案例；团队落地重点看第三、四篇。
• 团队落地时建议记录权限边界、验收标准和失败回退策略。
• 仓库文档路径含中文和空格，命令行操作时注意加引号。