From f6d1d062288e5d91dd549faa41957beecaa0cacf Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 9 Jun 2022 11:06:34 +0300 Subject: [PATCH] Added guidelines for sidebar labels --- docs/content/contribution-guidelines.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/content/contribution-guidelines.md b/docs/content/contribution-guidelines.md index 9c1688b872..17d7f232c8 100644 --- a/docs/content/contribution-guidelines.md +++ b/docs/content/contribution-guidelines.md @@ -59,6 +59,12 @@ In the body of the PR, explain clearly what the PR does. If the PR solves an iss When you add a new page to the documentation, you must add the new page in `www/docs/sidebars.js` under the `tutorialSidebar`. You can learn more about the syntax used [here](https://docusaurus.io/docs/sidebar/items). +### Terminology + +When the documentation page is a conceptual or overview documentation, the label in the sidebar should start with a noun. + +When the documentation page is a tutorial documentation, the label in the sidebar should start with a verb. An exception of this rule are integration documentations and upgrade guides. + ## Notes and Additional Information When displaying notes and additional information in a documentation page, use [Admonitions](https://docusaurus.io/docs/markdown-features/admonitions). Make sure the type of admonition used matches the note’s importance to the current document.