Skip to content

Commit

Permalink
docs: optimize doc of writing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Undertone0809 committed Oct 15, 2024
1 parent e1f555d commit 2acb7f4
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/other/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/`.
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
],
},
]
```

0 comments on commit 2acb7f4

Please sign in to comment.