Cleaned up left nav

maester365 · Mar 16, 2024 · ca93228 · ca93228
1 parent 4b492c7
commit ca93228
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 31 deletions.
diff --git a/build/Build-CommandReference.ps1 b/build/Build-CommandReference.ps1
@@ -1,7 +1,6 @@
 # Description: This script is used to generate the 'Command Reference' section of the Maester docusaurus site
 # * This command needs to be run from the root of the project. e.g. ./build/Build-CommandReference.ps1
 # * The New-DocusaurusHelp command deletes and recreates the ./docs/docs/commands folder
-# * The Copy-Item command copies the ./docs/docs-templates/commands-index.md file to ./docs/docs/commands/index.md
 # * If running the docusaurus site locally you will need to stop and start Docusaurus to clear the 'Module not found' errors after running this command
 
 if (-not (Get-Module Alt3.Docusaurus.Powershell -ListAvailable)) {
@@ -10,5 +9,4 @@ if (-not (Get-Module Alt3.Docusaurus.Powershell -ListAvailable)) {
 }
 Import-Module Alt3.Docusaurus.Powershell
 Import-Module PlatyPS
-New-DocusaurusHelp -Module ./src/Maester.psm1 -DocsFolder ./docs/docs -NoPlaceHolderExamples -EditUrl https://github.com/maester365/maester/blob/main/src/public/
-Copy-Item ./docs/docs-templates/commands-index.md ./docs/docs/commands/index.md
+New-DocusaurusHelp -Module ./src/Maester.psm1 -DocsFolder ./docs/docs -NoPlaceHolderExamples -EditUrl https://github.com/maester365/maester/blob/main/src/public/
diff --git a/docs/docs-templates/readme.md b/docs/docs-templates/readme.md
diff --git a/docs/docs/automation-overview.md → docs/docs/automation/@readme.md b/docs/docs/automation-overview.md → docs/docs/automation/@readme.md
@@ -1,5 +1,7 @@
 ---
 id: automation-overview
+sidebar_label: Overview
+sidebar_position: 1
 title: Set up Maester to automatically run daily
 ---
 

diff --git a/docs/docs/commands-overview.md b/docs/docs/commands-overview.md
@@ -10,7 +10,7 @@ import DocCardList from '@theme/DocCardList';
 ## Overview
 This page lists the commands available in the Maester module and provides a reference of the helper methods that have been created to help you define and run tests on your Microsoft 365 cloud configuration.
 
-See the [writing Maester tests](../writing-tests) guide for more information on how to write your own tests using these commands.
+See the [writing Maester tests](./writing-tests) guide for more information on how to write your own tests using these commands.
 
 ## Maester Commands
 <DocCardList />

diff --git a/docs/docs/commands/index.md b/docs/docs/commands/index.md
diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md
@@ -3,8 +3,12 @@ sidebar_position: 5
 title: Contributing
 ---
 
+import TOCInline from '@theme/TOCInline';
+
 # Contributing
 
+<TOCInline toc={toc} />
+
 ## Contributing to docs
 
 Simple edits can be made in the GitHub UI by clicking the 'Edit this page' at the bottom of each page or you can browse to the [docs](https://github.com/maester365/maester/tree/main/docs/docs) folder on GitHub.
@@ -45,7 +49,7 @@ You will now be able to edit add and edit markdown files in the ./docs/docs fold
 - You can search for icons at [Iconify](https://icon-sets.iconify.design/) and include them in the markdown. See the [Daily Automation](https://measter.dev/docs/automation/) page for examples.
 - The `Command Reference` section is auto-generated. To update the documentation for this, the .ps1 file for the command needs to be updated with comment-based documentation.
 
-## Maester Developer Guide
+## Maester cmdlet dev guide
 
 ### Simple debugging
 

diff --git a/docs/docs/tests/index.md → docs/docs/tests/@readme.md b/docs/docs/tests/index.md → docs/docs/tests/@readme.md
@@ -1,5 +1,5 @@
 ---
-id: tests
+id: tests-overview
 title: Maester - Out of the box tests
 sidebar_label: Overview
 sidebar_position: 1

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -77,7 +77,7 @@ const config = {
           {
             type: "doc",
             position: "left",
-            docId: "tests/tests",
+            docId: "tests/tests-overview",
             label: "Tests",
           },
           {

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -9,10 +9,7 @@ const sidebars = {
       type: "category",
       label: "Daily Automation",
       collapsed: false,
-      items: [
-        { type: "doc", id: "automation-overview", label: "Overview" },
-        { type: "autogenerated", dirName: "automation" },
-      ],
+      items: [{ type: "autogenerated", dirName: "automation" }],
     },
     "contributing",
     {