asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Added guidelines for sidebar labels

Browse Source
This commit is contained in:
Shahed Nasser
2022-06-09 11:06:34 +03:00
committed by GitHub
parent e562d2749f
commit f6d1d06228
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/content/contribution-guidelines.md
View File

@@ -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.