Google Git
Sign in
apache / dubbo-js / 6e465653ac0e690603af1bc8c32e5f15d47a05fe^2..6e465653ac0e690603af1bc8c32e5f15d47a05fe / .
commit6e465653ac0e690603af1bc8c32e5f15d47a05fe[log] [tgz]
authorKen Liu <ken.lj.hz@gmail.com>Mon Mar 25 15:03:12 2024 +0800
committerGitHub <noreply@github.com>Mon Mar 25 15:03:12 2024 +0800
tree7a3bd5ba582ac0bfe276452f0cbae2d51c25b38e
parent3101874a5848ced89266433cb4a1fce973bb0a84 [diff]
parent340bc38c1083a20ba94cf7eb3e8bad9a19ec45d9 [diff]
Merge pull request #385 from 7inspire/patch-1

docs: Update README.md
diff --git a/.gitignore b/.gitignore
index 3b9930e..491bfea 100644
--- a/.gitignore
+++ b/.gitignore

@@ -56,3 +56,7 @@
 # System Files
 .DS_Store
 Thumbs.db
+
+# docs
+.vitepress/cache
+

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index f9a98f8..6cbe540 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts

@@ -33,10 +33,107 @@
     sidebar: [
       {
         text: 'Guide',
+        collapsed: true,
         items: [
           {
-            text: 'Getting Started',
+            text: 'Introduce',
             link: '/guide/'
+          },
+          {
+            text: 'Dubbo for Web',
+            collapsed: true,
+            items: [
+              {
+                text: 'Getting Started',
+                link: '/guide/dubboForWEB/GettingStarted'
+              },
+              {
+                text: 'Generating Code',
+                link: '/guide/dubboForWEB/GeneratingCode'
+              },
+              {
+                text: 'Using clients',
+                link: '/guide/dubboForWEB/UsingClients'
+              },
+              {
+                text: 'Errors',
+                link: '/guide/dubboForWEB/Errors'
+              },
+              {
+                text: 'Headers & trailers',
+                link: '/guide/dubboForWEB/HeadersandTrailers'
+              },
+              {
+                text: 'Cancellation & Timeouts',
+                link: '/guide/dubboForWEB/CancellationandTimeouts'
+              },
+              {
+                text: 'Interceptors',
+                link: '/guide/dubboForWEB/Interceptors'
+              },
+              {
+                text: 'Choosing a protocol',
+                link: '/guide/dubboForWEB/Choosingaprotocol'
+              },
+              {
+                text: 'Supported browsers & frameworks',
+                link: '/guide/dubboForWEB/SupportedBrowsersandFrameworks'
+              },
+              {
+                text: 'Common errors',
+                link: '/guide/dubboForWEB/CommonErrors'
+              },
+              {
+                text: 'Testing',
+                link: '/guide/dubboForWEB/Testing'
+              },
+              {
+                text: 'Get Requests and Caching',
+                link: '/guide/dubboForWEB/GetRequestsandCaching'
+              },
+              {
+                text: 'Server-Side Rendering (SSR)',
+                link: '/guide/dubboForWEB/ServerSideRendering'
+              },
+              {
+                text: 'Connect for TanStack Query',
+                link: '/guide/dubboForWEB/ConnectForTanStackQuery'
+              }
+            ]
+          },
+          {
+            text: 'Dubbo for Node.js',
+            collapsed: true,
+            items: [
+              {
+                text:"Getting started",
+                link:"/guide/dubboForNode/GettingStarted"
+              },
+              {
+                text:"Implementing services",
+                link:"/guide/dubboForNode/ImplementingServices"
+              },
+              {
+                text:"Server plugins",
+                link:"/guide/dubboForNode/ServerPlugins"
+              },
+              {
+                text:"Interceptors",
+                link:"/guide/dubboForNode/Interceptors"
+              },
+              {
+                text:"Using clients",
+                link:"/guide/dubboForNode/UsingClients"
+              },
+              {
+                text:"Get Requests and Caching",
+                link:"/guide/dubboForNode/GetRequestsAndCaching"
+              },
+              {
+                text:"Testing",
+                link:"/guide/dubboForNode/Testing"
+              }
+            ]
           }
         ]
       },

diff --git a/docs/guide/dubboForNode/GetRequestsAndCaching.md b/docs/guide/dubboForNode/GetRequestsAndCaching.md
new file mode 100644
index 0000000..5efce1c
--- /dev/null
+++ b/docs/guide/dubboForNode/GetRequestsAndCaching.md

@@ -0,0 +1 @@
+# GetRequestsAndCaching

diff --git a/docs/guide/dubboForNode/GettingStarted.md b/docs/guide/dubboForNode/GettingStarted.md
new file mode 100644
index 0000000..aa0c9ab
--- /dev/null
+++ b/docs/guide/dubboForNode/GettingStarted.md

@@ -0,0 +1 @@
+# GettingStarted

diff --git a/docs/guide/dubboForNode/ImplementingServices.md b/docs/guide/dubboForNode/ImplementingServices.md
new file mode 100644
index 0000000..20bf108
--- /dev/null
+++ b/docs/guide/dubboForNode/ImplementingServices.md

@@ -0,0 +1 @@
+# ImplementingServices

diff --git a/docs/guide/dubboForNode/Interceptors.md b/docs/guide/dubboForNode/Interceptors.md
new file mode 100644
index 0000000..a4528c4
--- /dev/null
+++ b/docs/guide/dubboForNode/Interceptors.md

@@ -0,0 +1 @@
+# Interceptors

diff --git a/docs/guide/dubboForNode/ServerPlugins.md b/docs/guide/dubboForNode/ServerPlugins.md
new file mode 100644
index 0000000..9a247fc
--- /dev/null
+++ b/docs/guide/dubboForNode/ServerPlugins.md

@@ -0,0 +1 @@
+# ServerPlugins

diff --git a/docs/guide/dubboForNode/Testing.md b/docs/guide/dubboForNode/Testing.md
new file mode 100644
index 0000000..f00b526
--- /dev/null
+++ b/docs/guide/dubboForNode/Testing.md

@@ -0,0 +1 @@
+# Testing

diff --git a/docs/guide/dubboForNode/UsingClients.md b/docs/guide/dubboForNode/UsingClients.md
new file mode 100644
index 0000000..bd3526b
--- /dev/null
+++ b/docs/guide/dubboForNode/UsingClients.md

@@ -0,0 +1 @@
+# UsingClients

diff --git a/docs/guide/dubboForWEB/CancellationandTimeouts.md b/docs/guide/dubboForWEB/CancellationandTimeouts.md
new file mode 100644
index 0000000..77a2f99
--- /dev/null
+++ b/docs/guide/dubboForWEB/CancellationandTimeouts.md

@@ -0,0 +1 @@
+# CancellationandTimeouts

diff --git a/docs/guide/dubboForWEB/Choosingaprotocol.md b/docs/guide/dubboForWEB/Choosingaprotocol.md
new file mode 100644
index 0000000..f8e14b9
--- /dev/null
+++ b/docs/guide/dubboForWEB/Choosingaprotocol.md

@@ -0,0 +1 @@
+# Choosing a protocol

diff --git a/docs/guide/dubboForWEB/CommonErrors.md b/docs/guide/dubboForWEB/CommonErrors.md
new file mode 100644
index 0000000..7293ed7
--- /dev/null
+++ b/docs/guide/dubboForWEB/CommonErrors.md

@@ -0,0 +1 @@
+# CommonErrors

diff --git a/docs/guide/dubboForWEB/ConnectForTanStackQuery.md b/docs/guide/dubboForWEB/ConnectForTanStackQuery.md
new file mode 100644
index 0000000..04dec35
--- /dev/null
+++ b/docs/guide/dubboForWEB/ConnectForTanStackQuery.md

@@ -0,0 +1 @@
+# ConnectForTanStackQuery

diff --git a/docs/guide/dubboForWEB/Errors.md b/docs/guide/dubboForWEB/Errors.md
new file mode 100644
index 0000000..165d08c
--- /dev/null
+++ b/docs/guide/dubboForWEB/Errors.md

@@ -0,0 +1 @@
+# Errors

diff --git a/docs/guide/dubboForWEB/GeneratingCode.md b/docs/guide/dubboForWEB/GeneratingCode.md
new file mode 100644
index 0000000..eaa3a3a
--- /dev/null
+++ b/docs/guide/dubboForWEB/GeneratingCode.md

@@ -0,0 +1,2 @@
+# Generating code
+# todo

diff --git a/docs/guide/dubboForWEB/GetRequestsandCaching.md b/docs/guide/dubboForWEB/GetRequestsandCaching.md
new file mode 100644
index 0000000..cbc8498
--- /dev/null
+++ b/docs/guide/dubboForWEB/GetRequestsandCaching.md

@@ -0,0 +1 @@
+# GetRequestsandCaching

diff --git a/docs/guide/dubboForWEB/GettingStarted.md b/docs/guide/dubboForWEB/GettingStarted.md
new file mode 100644
index 0000000..bad5562
--- /dev/null
+++ b/docs/guide/dubboForWEB/GettingStarted.md

@@ -0,0 +1 @@
+# Getting Started

diff --git a/docs/guide/dubboForWEB/HeadersandTrailers.md b/docs/guide/dubboForWEB/HeadersandTrailers.md
new file mode 100644
index 0000000..4a4f522
--- /dev/null
+++ b/docs/guide/dubboForWEB/HeadersandTrailers.md

@@ -0,0 +1 @@
+# HeadersandTrailers

diff --git a/docs/guide/dubboForWEB/Interceptors.md b/docs/guide/dubboForWEB/Interceptors.md
new file mode 100644
index 0000000..a4528c4
--- /dev/null
+++ b/docs/guide/dubboForWEB/Interceptors.md

@@ -0,0 +1 @@
+# Interceptors

diff --git a/docs/guide/dubboForWEB/ServerSideRendering.md b/docs/guide/dubboForWEB/ServerSideRendering.md
new file mode 100644
index 0000000..33329f7
--- /dev/null
+++ b/docs/guide/dubboForWEB/ServerSideRendering.md

@@ -0,0 +1 @@
+# Server-SideRendering

diff --git a/docs/guide/dubboForWEB/SupportedBrowsersandFrameworks.md b/docs/guide/dubboForWEB/SupportedBrowsersandFrameworks.md
new file mode 100644
index 0000000..c4dc38b
--- /dev/null
+++ b/docs/guide/dubboForWEB/SupportedBrowsersandFrameworks.md

@@ -0,0 +1 @@
+# SupportedBrowsersandFrameworks

diff --git a/docs/guide/dubboForWEB/Testing.md b/docs/guide/dubboForWEB/Testing.md
new file mode 100644
index 0000000..f00b526
--- /dev/null
+++ b/docs/guide/dubboForWEB/Testing.md

@@ -0,0 +1 @@
+# Testing

diff --git a/docs/guide/dubboForWEB/UsingClients.md b/docs/guide/dubboForWEB/UsingClients.md
new file mode 100644
index 0000000..a8c9d5d
--- /dev/null
+++ b/docs/guide/dubboForWEB/UsingClients.md

@@ -0,0 +1,2 @@
+# Using Clients
+# todo

diff --git a/docs/guide/index.md b/docs/guide/index.md
index e8befe1..5efef4f 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md

@@ -1,3 +1 @@
-# Getting Started
-
-TODO...
+# introduce