Skip to content

添加 VitePress 文档站并生成 ZenTao API 参考#2

Merged
catouse merged 4 commits into
mainfrom
codex/add-vitepress-docs
May 11, 2026
Merged

添加 VitePress 文档站并生成 ZenTao API 参考#2
catouse merged 4 commits into
mainfrom
codex/add-vitepress-docs

Conversation

@catouse
Copy link
Copy Markdown
Collaborator

@catouse catouse commented May 11, 2026

Summary

  • 新增 VitePress 文档站,包含 GuideReferenceZenTao API 三大导航区
  • Guide 补充安装、运行环境、常见调用示例、Profile 和错误处理说明
  • Reference 通过 TypeDoc 生成包根公开 API 文档
  • ZenTao API 基于 src/modules/registry.ts 的运行时注册表动态生成,并按模块分类输出
  • 补充文档生成脚本、TypeDoc 配置、忽略规则与对应测试

Testing

  • bun test / bun run check 通过
  • bun run docs:generatebun run docs:build 通过
  • bun run docs:preview 本地预览可正常启动并访问文档站

@catouse catouse marked this pull request as ready for review May 11, 2026 12:32
@catouse catouse merged commit 98d6dc7 into main May 11, 2026
0 of 4 checks passed
@catouse catouse deleted the codex/add-vitepress-docs branch May 11, 2026 12:33
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