From 583562be41e0fffedb2c59369f6c34e954bfb26b Mon Sep 17 00:00:00 2001
From: Sijie Shen <shensijie.ssj@alibaba-inc.com>
Date: Wed, 15 May 2024 10:26:37 +0800
Subject: [PATCH] doc: key concepts

Signed-off-by: Sijie Shen <shensijie.ssj@alibaba-inc.com>
---
 docs/docs.rst                                 |  3 +-
 .../{key-concepts => }/graph-storage.rst      |  0
 docs/documentation/design/key-concepts.rst    | 53 ------------------
 .../design/key-concepts/graph-server.rst      |  6 ---
 .../design/{key-concepts => }/rgmapping.rst   | 54 +++++++++----------
 5 files changed, 29 insertions(+), 87 deletions(-)
 rename docs/documentation/design/{key-concepts => }/graph-storage.rst (100%)
 delete mode 100644 docs/documentation/design/key-concepts.rst
 delete mode 100644 docs/documentation/design/key-concepts/graph-server.rst
 rename docs/documentation/design/{key-concepts => }/rgmapping.rst (82%)

diff --git a/docs/docs.rst b/docs/docs.rst
index 03a642c..9bd655e 100644
--- a/docs/docs.rst
+++ b/docs/docs.rst
@@ -85,7 +85,8 @@ Read the Paper
    :hidden:
 
    documentation/design/architecture
-   documentation/design/key-concepts
+   documentation/design/rgmapping
+   documentation/design/graph-storage
 
 .. toctree::
    :maxdepth: 1
diff --git a/docs/documentation/design/key-concepts/graph-storage.rst b/docs/documentation/design/graph-storage.rst
similarity index 100%
rename from docs/documentation/design/key-concepts/graph-storage.rst
rename to docs/documentation/design/graph-storage.rst
diff --git a/docs/documentation/design/key-concepts.rst b/docs/documentation/design/key-concepts.rst
deleted file mode 100644
index 607d83f..0000000
--- a/docs/documentation/design/key-concepts.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-.. _key-concepts:
-
-Key Concepts
-============
-
-.. toctree::
-   :maxdepth: 1
-   :caption: TOC
-   :hidden:
-
-   key-concepts/rgmapping.rst
-   key-concepts/graph-storage.rst
-   key-concepts/graph-server.rst
-
-The **User Guides** section provides an in-depth understanding of the design and implementation of GART. It includes detailed instructions for setting up the environment, the architecture, and the core features within the GART engine.
-
-.. tip::
-
-   If you are new to GART, we recommend that you start with the
-   `Quick Start <quick-start.html>`_ page for a smoother
-   introduction.
-
-Concepts
---------
-
-.. panels::
-   :header: text-center
-   :column: col-lg-12 p-2
-
-   .. link-button:: key-concepts/rgmapping
-      :type: ref
-      :text: RGMapping
-      :classes: btn-block stretched-link
-   ^^^^^^^^^^^^
-   The design of RGMapping and the interface to use it.
-
-   ---
-
-   .. link-button:: key-concepts/graph-storage
-      :type: ref
-      :text: Dynamic Graph Storage
-      :classes: btn-block stretched-link
-   ^^^^^^^^^^^^
-   The design of the dynamic graph storage in GART.
-
-   ---
-
-   .. link-button:: key-concepts/graph-server
-      :type: ref
-      :text: Graph Server
-      :classes: btn-block stretched-link
-   ^^^^^^^^^^^^
-   The design of the graph server in GART.
diff --git a/docs/documentation/design/key-concepts/graph-server.rst b/docs/documentation/design/key-concepts/graph-server.rst
deleted file mode 100644
index cd9a472..0000000
--- a/docs/documentation/design/key-concepts/graph-server.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. _graph-server:
-
-Graph Server
-==============
-
-GART's dynamic graph storage can be provided as a service to users. In addition to interfacing with GraphScope's different execution engines, users can perform read-only operations on GART's graph store via Python.
diff --git a/docs/documentation/design/key-concepts/rgmapping.rst b/docs/documentation/design/rgmapping.rst
similarity index 82%
rename from docs/documentation/design/key-concepts/rgmapping.rst
rename to docs/documentation/design/rgmapping.rst
index ab568d3..03ed91a 100644
--- a/docs/documentation/design/key-concepts/rgmapping.rst
+++ b/docs/documentation/design/rgmapping.rst
@@ -64,34 +64,34 @@ YAML
     method: append
     enableRowStore: false
     vertexMappings:
-    vertex_types:
-    - type_name: person
-        dataSourceName: PERSON
-        idFieldName: p_id
-        mappings:
-        - property: p_id
-        dataField:
-            name: P_ID
-        - property: p_name
-        dataField:
-            name: NAME
+        vertex_types:
+            - type_name: person
+              dataSourceName: PERSON
+              idFieldName: p_id
+              mappings:
+                - property: p_id
+                  dataField:
+                      name: P_ID
+                - property: p_name
+                  dataField:
+                      name: NAME
     edgeMappings:
-    edge_types:
-    - type_pair:
-        edge: transfer
-        source_vertex: person
-        destination_vertex: person
-        dataSourceName: TRANSFER
-        sourceVertexMappings:
-        - dataField:
-            name: P_ID1
-        destinationVertexMappings:
-        - dataField:
-            name: P_ID2
-        dataFieldMappings:
-        - property: t_date
-        dataField:
-            name: T_DATA
+        edge_types:
+            - type_pair:
+                edge: transfer
+                source_vertex: person
+                destination_vertex: person
+              dataSourceName: TRANSFER
+              sourceVertexMappings:
+                - dataField:
+                      name: P_ID1
+              destinationVertexMappings:
+                - dataField:
+                      name: P_ID2
+              dataFieldMappings:
+                - property: t_date
+                  dataField:
+                      name: T_DATA
 
 The RGMapping rule can also be written in `YAML`_. It defines the graph schema for the graph named ``ldbc``. It specifies the mapping between the vertices, edges and their properties in the graph and the columns in the table.