From 1f26c3d169c304ad7a6bad990644d402e06e22e2 Mon Sep 17 00:00:00 2001 From: hengm3467 <100685635+hengm3467@users.noreply.github.com> Date: Fri, 22 Nov 2024 16:19:20 +0800 Subject: [PATCH] Update README.md Signed-off-by: hengm3467 <100685635+hengm3467@users.noreply.github.com> --- README.md | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ddefad51..26b95786 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,29 @@ This repository contains the latest RisingWave documentation. [The old repository](https://github.com/risingwavelabs/risingwave-docs-legacy) now hosts the archived documentation up to v2.0 of RisingWave. +# Documentation structure + +Below are the main topic groups. Some groups are elevated to be tabs shown on the top of a documentation page. + +- get-started +- demos +- sql +- ingestion +- processing +- delivery +- deploy +- operate +- python-sdk +- client-libraries +- performance +- troubleshoot +- integrations +- faq +- reference +- cloud +- changelog -# Mintlify Starter Kit - -Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including - -- Guide pages -- Navigation -- Customizations -- API Reference pages -- Use of popular components - ### Development Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command