Skip to content

[TASK-tsk_6083877ffe1019f170f0f8d7][Frontend] feat: Add Docusaurus documentation website#236

Closed
jsyqrt wants to merge 1 commit into
feature/gap-fillingfrom
task/tsk_6083877ffe1019f170f0f8d7
Closed

[TASK-tsk_6083877ffe1019f170f0f8d7][Frontend] feat: Add Docusaurus documentation website#236
jsyqrt wants to merge 1 commit into
feature/gap-fillingfrom
task/tsk_6083877ffe1019f170f0f8d7

Conversation

@jsyqrt

@jsyqrt jsyqrt commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

📋 基本信息

  • 提交者: Frontend Developer (ID: agt_ca836fdc2c08b8e9ec1370a8)
  • 关联任务: [TASK-tsk_6083877ffe1019f170f0f8d7]
  • 目标分支: feature/gap-filling

🎯 背景与动机 (Why)

Markus 项目需要一个结构化的开发者文档站点,收录架构文档、API 参考、部署指南、贡献指南等核心内容,替代分散的 GitBook/Feishu 文档,提升开发者上手体验。

🔧 变更内容 (What)

  • 创建 Docusaurus 3.10.1 站点(website/ 目录),支持中英文双语
  • 配置 i18n(en/zh-CN)、导航栏、页脚、侧边栏、SEO 元数据
  • 编写核心文档:intro, quick-start, installation, architecture(8篇)
  • 编写开发者指南:dev-setup, coding-standards, contributing, PRs, testing
  • 编写 API 参考:overview, agents, chat, deliverables, integrations, projects, requirements, tasks
  • 编写部署指南:configuration, docker, remote-access
  • 添加博客欢迎文章
  • 在根 package.json 添加 docs:build/docs:dev/docs:serve 脚本
  • 添加 GitHub Actions CI workflow (docs.yml) 构建文档
  • 注册 website 为 pnpm workspace 成员
  • 更新 .gitignore 包含 Docusaurus 构建产物

✅ 验证方式 (How to Verify)

  • pnpm install 通过
  • cd website && pnpm build 通过(中英文双版本构建成功,120+ 页面)
  • PR 合并后 GitHub Actions Docs workflow 应自动构建

👤 评审人

  • Reviewer: Code Reviewer

…n website

- Initialize Docusaurus 3.10.1 site in website/ directory
- Configure i18n (en/zh-CN), navbar, footer, sidebar, SEO
- Add core documentation: intro, quick-start, installation, architecture
- Add developer guides: dev-guide, state-machines, memory-system, api, prompts
- Add contributing docs and deployment guides
- Add blog with welcome post
- Add docs scripts to root package.json (docs:build, docs:dev, docs:serve)
- Add CI workflow for docs build
- Register website as pnpm workspace package
- Update .gitignore for Docusaurus build artifacts

PR target: feature/gap-filling
@jsyqrt

jsyqrt commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

废弃此 PR — 文档应放在 jsyqrt/markus-hub 仓库的已有 Astro 站点中(老板要求)。参见 task tsk_6083877ffe1019f170f0f8d7。

@jsyqrt jsyqrt closed this Jul 2, 2026
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