Skip to content

Commit f7ba1b3

Browse files
committed
add some guidance to docs readme
1 parent eaf653f commit f7ba1b3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,13 @@ make server
3030
When you are done with your changes just create a pull request, after merging
3131
the pull request the website will be updated automatically.
3232

33+
34+
### Tips
35+
36+
- Instead of adding things to the FAQ, try to consolidate information with existing pages or create a new section if enough once content is available.
37+
38+
- For new pages, select a good location in the sidebar using the `menu.sidebar.weight` and `menu.sidebar.parent` metadata attributes
39+
3340
## Contributing
3441

3542
Fork -> Patch -> Push -> Pull Request

0 commit comments

Comments
 (0)