From 2acb7f4575d9da2431535213c3c781e5f7a58e44 Mon Sep 17 00:00:00 2001 From: zeeland Date: Wed, 16 Oct 2024 01:43:59 +0800 Subject: [PATCH] docs: optimize doc of writing doc --- docs/other/contribution.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/other/contribution.md b/docs/other/contribution.md index d9a02e9f..3ffdc11f 100644 --- a/docs/other/contribution.md +++ b/docs/other/contribution.md @@ -157,4 +157,20 @@ Run the following command to startup the documentation server: npm run dev ``` -When you add a new feature, you are recommended to add a demo notebook in `example/`. Moreover, you can add corresponding documentation in `docs/`. \ No newline at end of file +When you add a new feature, you are recommended to add a demo notebook in `example/`. Moreover, you can add corresponding documentation in `docs/`. + +Moreover, you need add sidebar information in `docs/.vitepress/config.mts` after you add the new documentation. eg: + +```ts +export const sidebar = [ + { + text: 'Guide', + items: [ + // add your sidebar information in relevant directory + { text: 'Getting Started', link: '/guide/getting-started' }, + { text: 'How to write model name', link: '/guide/how-to-write-model-name' }, + ... // other sidebar information + ], + }, +] +```