docs(tutorial): setup documentation by VitePress

.github/workflows/deploy-docs.yml

@@ -0,0 +1,59 @@
+name: Deploy Documentation
+
+on:
+    push:
+        branches:
+            - main
+        paths:
+            - 'docs/**'
+    workflow_dispatch:
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: pages
+    cancel-in-progress: false
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+                  cache: npm
+
+            - name: Setup Pages
+              uses: actions/configure-pages@v4
+
+            - name: Install dependencies
+              run: npm ci
+
+            - name: Build with VitePress
+              run: npm run docs:build
+
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: docs/.vitepress/dist
+
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        needs: build
+        runs-on: ubuntu-latest
+        name: Deploy
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.gitignore

@@ -45,3 +45,7 @@ logs/
 *.log
 
 dist/
+
+# Docs
+docs/.vitepress/dist
+docs/.vitepress/cache

docs/.vitepress/config.mts

@@ -0,0 +1,125 @@
+import { defineConfig } from 'vitepress';
+
+// Shared configuration
+const sharedThemeConfig = {
+    socialLinks: [
+        {
+            icon: 'github',
+            link: 'https://github.com/agentscope-ai/agentscope-studio',
+        },
+    ],
+};
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    srcDir: 'tutorial',
+
+    title: 'AgentScope-Studio',
+    description: 'A development-oriented visualization toolkit for AgentScope',
+
+    rewrites: {
+        'en/:rest*': ':rest*',
+    },
+
+    locales: {
+        root: {
+            label: 'English',
+            lang: 'en',
+            themeConfig: {
+                ...sharedThemeConfig,
+                nav: [
+                    { text: 'Home', link: '/' },
+                    { text: 'Tutorial', link: '/tutorial/overview' },
+                ],
+                sidebar: [
+                    {
+                        text: 'Tutorial',
+                        items: [
+                            {
+                                text: 'Overview',
+                                link: '/tutorial/overview',
+                            },
+                            {
+                                text: 'Quick Start',
+                                link: '/tutorial/quick_start',
+                            },
+                            {
+                                text: 'Contributing',
+                                link: '/tutorial/contributing',
+                            },
+                        ],
+                    },
+                    {
+                        text: 'Develop',
+                        items: [
+                            { text: 'Project', link: '/develop/project' },
+                            { text: 'Tracing', link: '/develop/tracing' },
+                            {
+                                text: 'Evaluation',
+                                link: '/develop/evaluation',
+                            },
+                        ],
+                    },
+                    {
+                        text: 'Agent',
+                        items: [{ text: 'Friday', link: '/agent/friday' }],
+                    },
+                ],
+            },
+        },
+        zh_CN: {
+            label: '简体中文',
+            lang: 'zh-CN',
+            link: '/zh_CN/',
+            themeConfig: {
+                ...sharedThemeConfig,
+                nav: [
+                    { text: '首页', link: '/zh_CN/' },
+                    { text: '教程', link: '/zh_CN/tutorial/overview' },
+                ],
+                sidebar: [
+                    {
+                        text: '教程',
+                        items: [
+                            {
+                                text: '概览',
+                                link: '/zh_CN/tutorial/overview',
+                            },
+                            {
+                                text: '快速开始',
+                                link: '/zh_CN/tutorial/quick_start',
+                            },
+                            {
+                                text: '贡献指南',
+                                link: '/zh_CN/tutorial/contributing',
+                            },
+                        ],
+                    },
+                    {
+                        text: '开发',
+                        items: [
+                            {
+                                text: '项目管理',
+                                link: '/zh_CN/develop/project',
+                            },
+                            {
+                                text: '运行追踪',
+                                link: '/zh_CN/develop/tracing',
+                            },
+                            {
+                                text: '应用评测',
+                                link: '/zh_CN/develop/evaluation',
+                            },
+                        ],
+                    },
+                    {
+                        text: '智能体',
+                        items: [
+                            { text: 'Friday', link: '/zh_CN/agent/friday' },
+                        ],
+                    },
+                ],
+            },
+        },
+    },
+});

docs/tutorial/en/agent/friday.md

@@ -0,0 +1,49 @@
+# AgentScope-Friday
+
+Friday is an experimental local-deployed agent built by AgentScope, aims at
+
+- answering questions about the AgentScope,
+- providing a quick secondary development environment for developers,
+- integrating all available features in AgentScope to build a more powerful agent, and
+- testing and integrating the advanced features in AgentScope.
+
+Its source code is also open-sourced in the [AgentScope-Studio repository](https://github.com/agentscope-ai/agentscope-studio/tree/main/packages/app).
+
+The code structure is as follows:
+
+```
+packages/
+    app/
+        friday/
+            tool/
+            utils/
+                connect.py  # The websocket connection used for realtime steering/interruption
+                ...
+            main.py         # The entry point of Friday agent
+            args.py         # The argument parser for Friday agent
+            hook.py         # The hook functions used to push messages to AgentScope-Studio frontend
+            model.py        # Initialize the LLM based on the configuration
+        requirements.txt    # The dependencies for Friday agent
+```
+
+## How to Use
+
+At the first time using Friday, you need to configure the agent in the following page, including the model, API KEY,
+tools, and other parameters.
+
+![Friday Configuration Page](assets/friday_setting.png)
+
+After that, you can start chatting with Friday in the chat page.
+
+## Equipped Features
+
+We are continuously integrating more features into Friday. The current and upcoming features include:
+
+- [x] Basic chat functionality with LLMs
+- [x] Support meta tool
+- [x] Support realtime steering/interruption
+- [x] Support state/Session management
+- [ ] 🚧 Support planning and plan visualization
+- [ ] 🚧 Support long-term memory
+- [ ] Support anthropic agent skill
+- [ ] Support user to add MCP server dynamically

docs/tutorial/en/develop/evaluation.md

@@ -0,0 +1,3 @@
+# Evaluation
+
+Coming soon ...