Skip to content

docs(tutorial): setup documentation by VitePress#52

Merged
DavdGao merged 11 commits into
agentscope-ai:mainfrom
DavdGao:dev/docs
Dec 2, 2025
Merged

docs(tutorial): setup documentation by VitePress#52
DavdGao merged 11 commits into
agentscope-ai:mainfrom
DavdGao:dev/docs

Conversation

@DavdGao

@DavdGao DavdGao commented Nov 18, 2025

Copy link
Copy Markdown
Member

Description

Setup the documentation by VitePress

Checklist

Please check the following items before code is ready to be reviewed.

  • Code has been formatted with npm run format command in the root directory
  • Docstrings/comments are in appropriate style (TSDoc/JSDoc for TypeScript/JavaScript, Google style for Python)
  • Related documentation has been updated (e.g. links, examples, etc.)
  • Code is ready for review

@DavdGao DavdGao added the documentation Improvements or additions to documentation label Nov 18, 2025
Comment thread docs/tutorial/zh_CN/tutorial/quick_start.md
Comment thread docs/tutorial/zh_CN/src/develop/tracing.md Outdated
Comment thread docs/tutorial/zh_CN/src/agent/friday.md Outdated
Comment thread docs/tutorial/zh_CN/src/agent/friday.md Outdated
Comment thread docs/tutorial/zh_CN/src/tutorial/overview.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread package.json
Comment thread docs/tutorial/en/index.md Outdated
Comment thread docs/tutorial/en/index.md Outdated
Comment thread docs/.vitepress/config.mts
@cla-assistant

cla-assistant Bot commented Dec 2, 2025

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ zhijianma
✅ DavdGao
❌ Cirilla-zmh
You have signed the CLA already but the status is still pending? Let us recheck it.

@DavdGao DavdGao merged commit 3e1b9c8 into agentscope-ai:main Dec 2, 2025
1 of 2 checks passed
@zhijianma zhijianma linked an issue Dec 10, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(tutorial): add tutorial for agentscope-studio

4 participants