docs: adjust docs framework (#6598)

* docs: 调整官网文档部分的结构 * docs: 调整官网文档部分的结构 * docs: 调整官网文档顺序，合并部分文档，修正内部跳转链接 * docs: 修正api部分跳转链接 * feat: 开启文档用户反馈 * docs: 新增选项一览菜单 * docs: resolution of meeting issues * docs: 删除无用文档，修改链接 * docs: change badge refer to * fix: fix ci * fix: fix ci * fix: fix ci * fix: fix ci
antvis · Feb 13, 2025 · 7f2b04a · 7f2b04a
1 parent cbff5f0
commit 7f2b04a
Show file tree

Hide file tree

Showing 562 changed files with 6,139 additions and 5,088 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -27,6 +27,7 @@ jobs:
       - name: Update coverall
         if: ${{ success() }}
         uses: coverallsapp/github-action@master
+        continue-on-error: true  # 暂时改动
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
 

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 G2 is a visualization grammar for dashboard building, data exploration and storytelling.
 
-[![Build Status](https://github.com/antvis/g2/workflows/build/badge.svg?branch=v5)](https://github.com/antvis//actions)
+[![Build Status](https://github.com/antvis/G2/actions/workflows/build.yml/badge.svg)](https://github.com/antvis/G2/actions/workflows/build.yml)
 [![Coverage Status](https://img.shields.io/coveralls/github/antvis/g2/v5.svg)](https://coveralls.io/github/antvis/g2?branch=v5)
 [![npm Version](https://img.shields.io/npm/v/@antv/g2.svg)](https://www.npmjs.com/package/@antv/g2)
 [![npm Download](https://img.shields.io/npm/dm/@antv/g2.svg)](https://www.npmjs.com/package/@antv/g2)
@@ -22,7 +22,7 @@ G2 is named after Leland Wilkinson’s book _The Grammar of Graphics_ and was pr
 
 - [Introduction](https://g2.antv.antgroup.com/manual/introduction/what-is-g2) - a brief overview and G2's motivations
 - [Examples](https://g2.antv.antgroup.com/examples) - a large number of demos to learn from and copy-paste
-- [Tutorials](https://g2.antv.antgroup.com/manual/introduction/getting-started) - interactive case-driven guides of G2's core concepts
+- [Tutorials](https://g2.antv.antgroup.com/manual/quick-start) - interactive case-driven guides of G2's core concepts
 - [API Reference](https://g2.antv.antgroup.com/api/overview) - complete documentation for all visualization components
 - [Editor](https://editor.antv.antgroup.com/) - an intelligent generation tool based on AntV. It utilizes AI to reduce the development cost of data visualization, and can quickly generate visual charts through natural language.
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -11,12 +11,12 @@
 <p align="center">
   <a href="https://g2.antv.antgroup.com/manual/introduction/what-is-g2">介绍</a> •
   <a href="https://g2.antv.antgroup.com/examples">案例</a> •
-  <a href="https://g2.antv.antgroup.com/manual/introduction/getting-started">教程</a> •
+  <a href="https://g2.antv.antgroup.com/manual/quick-start">教程</a> •
   <a href="https://g2.antv.antgroup.com/api/overview">API</a> •
   <a href="https://editor.antv.antgroup.com/">Editor</a>
 </p>
 
-[![Build Status](https://github.com/antvis/g2/workflows/build/badge.svg?branch=v5)](https://github.com/antvis//actions)
+[![Build Status](https://github.com/antvis/G2/actions/workflows/build.yml/badge.svg)](https://github.com/antvis/G2/actions/workflows/build.yml)
 [![Coverage Status](https://img.shields.io/coveralls/github/antvis/g2/v5.svg)](https://coveralls.io/github/antvis/g2?branch=v5)
 [![npm Version](https://img.shields.io/npm/v/@antv/g2.svg)](https://www.npmjs.com/package/@antv/g2)
 [![npm Download](https://img.shields.io/npm/dm/@antv/g2.svg)](https://www.npmjs.com/package/@antv/g2)

diff --git a/site/.dumirc.ts b/site/.dumirc.ts
@@ -39,7 +39,8 @@ export default defineConfig({
     petercat: {
       show: true,
       token: '26c62f06-1155-4b2c-8f4b-aa443d4af2c6',
-    },
+    }, // 开启petercat辅助答疑机器人
+    feedback: true, // 开启文档用户反馈
     versions: {
       // 历史版本以及切换下拉菜单
       [version]: 'https://g2.antv.antgroup.com',
@@ -54,21 +55,13 @@ export default defineConfig({
     navs: [
       // 头部的菜单列表
       {
-        slug: 'docs/manual/introduction/what-is-g2',
+        slug: 'docs/manual/quick-start',
         title: {
           zh: '文档',
           en: 'Docs',
         },
         order: 3,
       },
-      {
-        slug: 'docs/spec/overview',
-        title: {
-          zh: '选项',
-          en: 'Spec',
-        },
-        order: 2,
-      },
       {
         slug: 'docs/api/overview',
         title: {
@@ -118,145 +111,151 @@ export default defineConfig({
           zh: '简介',
           en: 'Introduction',
         },
-        order: 1,
+        order: 2,
       },
       {
         slug: 'manual/core',
         title: {
           zh: '核心概念',
           en: 'Core Concepts',
         },
-        order: 2,
-      },
-      {
-        slug: 'manual/extra-topics',
-        title: {
-          zh: '进阶主题',
-          en: 'Extra Topics',
-        },
         order: 3,
       },
-      // docs
       {
-        slug: 'spec/data',
+        slug: 'manual/core/chart',
         title: {
-          zh: '数据 - Data',
-          en: 'Data',
+          zh: '图表（Chart）',
+          en: 'Chart',
         },
-        order: 3,
+        order: 1,
       },
       {
-        slug: 'spec/mark',
+        slug: 'manual/core/mark',
         title: {
-          zh: '图形 - Mark',
+          zh: '标记（Mark）',
           en: 'Mark',
         },
-        order: 4,
+        order: 2,
       },
       {
-        slug: 'spec/transform',
+        slug: 'manual/core/data',
         title: {
-          zh: '变换 - Transform',
-          en: 'Transform',
+          zh: '数据（Data）',
+          en: 'Data',
         },
-        order: 5,
+        order: 4,
       },
       {
-        slug: 'spec/scale',
+        slug: 'manual/core/scale',
         title: {
-          zh: '比例尺 - Scale',
+          zh: '比例尺（Scale）',
           en: 'Scale',
         },
         order: 6,
       },
       {
-        slug: 'spec/coordinate',
+        slug: 'manual/core/transform',
         title: {
-          zh: '坐标系 - Coordinate',
-          en: 'Coordinate',
+          zh: '转换（Transform）',
+          en: 'Transform',
         },
         order: 7,
       },
       {
-        slug: 'spec/composition',
+        slug: 'manual/core/coordinate',
         title: {
-          zh: '复合 - Composition',
-          en: 'Composition',
+          zh: '坐标系（Coordinate）',
+          en: 'Coordinate',
         },
         order: 8,
       },
       {
-        slug: 'spec/component',
+        slug: 'manual/core/animate',
         title: {
-          zh: '组件 - Component',
-          en: 'Component',
+          zh: '动画（Animate）',
+          en: 'Animate',
         },
-        order: 9,
+        order: 10,
       },
       {
-        slug: 'spec/label',
+        slug: 'manual/core/interaction',
         title: {
-          zh: '数据标签 - Label',
-          en: 'Label',
+          zh: '交互（Interaction）',
+          en: 'Interaction',
         },
-        order: 10,
+        order: 13,
       },
-
       {
-        slug: 'spec/animation',
+        slug: 'manual/core/composition',
         title: {
-          zh: '动画 - Animation',
-          en: 'Animation',
+          zh: '复合（Composition）',
+          en: 'Composition',
         },
-        order: 11,
+        order: 14,
       },
       {
-        slug: 'spec/interaction',
+        slug: 'manual/core/theme',
         title: {
-          zh: '交互 - Interaction',
-          en: 'Interaction',
+          zh: '主题（Theme）',
+          en: 'Theme',
+        },
+        order: 15,
+      },
+      {
+        slug: 'manual/component',
+        title: {
+          zh: '图表组件',
+          en: 'Chart Component',
+        },
+        order: 4,
+      },
+      {
+        slug: 'manual/extra-topics',
+        title: {
+          zh: '进阶主题',
+          en: 'Extra Topics',
         },
-        order: 12,
+        order: 5,
       },
       {
-        slug: 'spec/graph',
+        slug: 'manual/extra-topics/graph',
         title: {
-          zh: '关系图 - Graph',
+          zh: '关系图（Graph）',
           en: 'Graph',
         },
-        order: 13,
+        order: 5,
       },
       {
-        slug: 'spec/geo',
+        slug: 'manual/extra-topics/geo',
         title: {
-          zh: '地图 - Geo',
+          zh: '地图（Geo）',
           en: 'Geo',
         },
-        order: 14,
+        order: 5,
       },
       {
-        slug: 'spec/threed',
+        slug: 'manual/extra-topics/three-dimensional',
         title: {
-          zh: '3D 图表 - 3D Charts',
+          zh: '3D 图表（3D Chart）',
           en: '3D',
         },
-        order: 15,
+        order: 5,
       },
       {
-        slug: 'spec/theme',
+        slug: 'manual/extra-topics/plugin',
         title: {
-          zh: '主题 - Theme',
-          en: 'Theme',
+          zh: '插件扩展（Plugin）',
+          en: 'Plugin',
         },
-        order: 16,
+        order: 5,
       },
       {
-        slug: 'spec/plugin',
+        slug: 'manual/whats-new',
         title: {
-          zh: '插件扩展 - Plugin',
-          en: 'Plugin',
+          zh: '版本特性',
+          en: 'Whats New',
         },
-        order: 17,
+        order: 5,
       },
     ],
     examples: [
@@ -457,7 +456,7 @@ export default defineConfig({
             zh: '开始使用',
             en: 'Getting Started',
           },
-          link: `/manual/introduction/getting-started`,
+          link: `/manual/quick-start`,
         },
         {
           text: {

diff --git a/site/docs/api/chart.en.md b/site/docs/api/chart.en.md
@@ -3,4 +3,4 @@ title: Chart
 order: 2
 ---
 
-<!-- <embed src="@/docs/spec/chart.zh.md"></embed> -->
+<!-- <embed src="@/docs/manual/core/chart.zh.md"></embed> -->