diff --git a/docs/contributing.md b/docs/contributing.md index 6cfe2a1f2..2278dbf8e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -31,8 +31,9 @@ Documentation is written as a series of markdown files nested by topic in direct - Each top-level directory should contain an `index.md` file with an overall description of what that section contains. - The `index.md` should have an L1 header with the same title as the `navbar` section. - Markdown files in each directory represent sections shown along the left sidebar. -- Nested directories within each `navbar` section should be used to add an additional bold header on the left sidebar and _may_ also have an `index.md` file. - - Markdown files within each nested directory will fall under this additional bold header. +- Nested directories within each `navbar` section should be used to add an sections along the left sidebar. + - We can have multiple levels of nested directories. + - Nested directories may also have an `index.md` file with an L1 header and an overall description of what that section contains. - Any visual aids used in the docs should be placed in `docs/img` (see the [adding images section](#adding-images)). ## Adding new documentation diff --git a/mkdocs.yml b/mkdocs.yml index 92d45b369..444d53c07 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,6 +15,7 @@ theme: - navigation.tabs # persistent navbar on the top - navigation.tabs.sticky # sticky navbar - navigation.indexes # allow index pages to serve as overview pages for sections + - navigation.expand # collapsible sections are expanded by default plugins: - search # search bar @@ -23,6 +24,8 @@ markdown_extensions: - admonition # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition - attr_list # https://github.com/squidfunk/mkdocs-material/blob/master/docs/setup/extensions/python-markdown.md#attribute-lists - md_in_html # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html + + # Here is the basic structure of our navigation setup. #nav: # - Navbar section: