Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Improve documentation website #378

Merged
merged 15 commits into from
Mar 25, 2024
Merged
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,7 @@ dj_lint
# System Files
.DS_Store
Thumbs.db

# docs
.vitepress/cache

99 changes: 98 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,107 @@ module.exports = {
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"
}
]
}
]
},
Expand Down
1 change: 1 addition & 0 deletions docs/guide/dubboForNode/GetRequestsAndCaching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# GetRequestsAndCaching
1 change: 1 addition & 0 deletions docs/guide/dubboForNode/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# GettingStarted
1 change: 1 addition & 0 deletions docs/guide/dubboForNode/ImplementingServices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ImplementingServices
1 change: 1 addition & 0 deletions docs/guide/dubboForNode/Interceptors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Interceptors
1 change: 1 addition & 0 deletions docs/guide/dubboForNode/ServerPlugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ServerPlugins
1 change: 1 addition & 0 deletions docs/guide/dubboForNode/Testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Testing
1 change: 1 addition & 0 deletions docs/guide/dubboForNode/UsingClients.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# UsingClients
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/CancellationandTimeouts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CancellationandTimeouts
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/Choosingaprotocol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Choosing a protocol
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/CommonErrors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CommonErrors
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/ConnectForTanStackQuery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# ConnectForTanStackQuery
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/Errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Errors
2 changes: 2 additions & 0 deletions docs/guide/dubboForWEB/GeneratingCode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Generating code
# todo
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/GetRequestsandCaching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# GetRequestsandCaching
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting Started
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/HeadersandTrailers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# HeadersandTrailers
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/Interceptors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Interceptors
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/ServerSideRendering.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Server-SideRendering
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/SupportedBrowsersandFrameworks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# SupportedBrowsersandFrameworks
1 change: 1 addition & 0 deletions docs/guide/dubboForWEB/Testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Testing
2 changes: 2 additions & 0 deletions docs/guide/dubboForWEB/UsingClients.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Using Clients
# todo
4 changes: 1 addition & 3 deletions docs/guide/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# Getting Started

TODO...
# introduce
Loading