docs(tutorial): setup documentation by VitePress#52
Conversation
# Conflicts: # .prettierignore # package-lock.json
There was a problem hiding this comment.
Pull request overview
This PR sets up VitePress documentation for AgentScope-Studio, including comprehensive tutorials in both English and Chinese, API changes to support backward compatibility with deprecated fields, and automated GitHub Pages deployment.
Key Changes:
- Added VitePress v2.0.0-alpha.13 with complete documentation structure
- Deprecated API fields (
run_dir,name,role) with backward-compatible fallbacks - Created bilingual documentation covering quickstart, project management, tracing, and Friday agent
- Added GitHub Actions workflow for automated documentation deployment
Reviewed changes
Copilot reviewed 21 out of 42 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Added VitePress alpha version and documentation npm scripts |
| package-lock.json | Lock file updates for VitePress and its dependencies |
| packages/server/src/trpc/router.ts | API deprecation with backward-compatible field handling |
| eslint.config.mjs | Added cache directory to ignored paths |
| .gitignore | Excluded VitePress build artifacts |
| docs/.vitepress/config.mts | VitePress configuration with English/Chinese locales |
| docs/tutorial/**/*.md | Comprehensive documentation content in both languages |
| .github/workflows/deploy-docs.yml | GitHub Actions workflow for automated deployment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
Description
Setup the documentation by VitePress
Checklist
Please check the following items before code is ready to be reviewed.
npm run formatcommand in the root directory