Merge pull request #255 from jfirwin/move-about-documentation

Move about-documentation to developers/maintaining-documentation

docs/developers/maintaining-documentation/overview.md

@@ -2,16 +2,15 @@
 id: overview
 title: Maintaining Documentation
 sidebar_label: Maintaining Documentation
-slug: /about-documentation
 ---
 Meshtastic documentation is an important ingredient to the overall project. We want users to hit the ground running with the information they need right at their finger tips. This section will discuss the documentation software stack, file organization, and style guides.
 
 ## Software Stack
-All of our documentation resides on GitHub. Instructions for setting up your GitHub account are located [here](about-documentation/github).
+All of our documentation resides on GitHub. Instructions for setting up your GitHub account are located [here](github).
 
-Our documentation is powered by [Docusaurus](https://docusaurus.io) — a documentation platform built on React that utilizes markdown files. Because markdown files are easy to edit, most content changes should be fairly simple. Instructions for setting up your instance of Docusaurus are located [here](about-documentation/docusaurus).
+Our documentation is powered by [Docusaurus](https://docusaurus.io) — a documentation platform built on React that utilizes markdown files. Because markdown files are easy to edit, most content changes should be fairly simple. Instructions for setting up your instance of Docusaurus are located [here](docusaurus).
 
-Another component that we use is [Vercel](https://vercel.com) — a platform for frontend frameworks and static sites. Instructions for setting up your instance of Vercel are located [here](about-documentation/vercel).
+Another component that we use is [Vercel](https://vercel.com) — a platform for frontend frameworks and static sites. Instructions for setting up your instance of Vercel are located [here](vercel).
 
 ## Documentation Organization
 | Section | File Path | Description |
@@ -23,12 +22,12 @@ Another component that we use is [Vercel](https://vercel.com) — a platform for
 | Hardware Details | `docs/hardware` | Any hardware related content. Any time a user is attaching a peripheral accessory to their device. That includes 3d printed cases, antennas, buttons, chimes, rotary encoders, and screens. |
 | Radio Mesh Details | `docs/mesh` | This section discusses everything relating to the Meshtastic mesh. Mesh health metrics will be discussed here as well as topics such as signal strength, range and anyting else pertaining to "over the air". |
 | Contribute to Meshtastic | `docs/developers` | Details each of the projects and how they work together to give a developer an idea of how the Meshtastic ecosystem operates. |
-| About the Documentation | `docs/about-documentation` | This section explains how our documentation is organized, how to make edits to the documentation, view a local copy of your fork of the project. Style guides and tips will also be included here. |
+| About the Documentation | `docs/maintaining-documentation` | This section explains how our documentation is organized, how to make edits to the documentation, view a local copy of your fork of the project. Style guides and tips will also be included here. |
 | Legal | `docs/legal` | Any legal information. Most changes here will be handled by developers actually working on the projects that require any legal disclosures. Examples include: the Meshtastic trademark, terms of service, and privacy policy. |
 
 ## Quick Start
 
-Assuming you have the [prerequisites installed](about-documentation/serve-docs-locally#prerequisites), running a local instance of Docusaurus takes three steps:
+Assuming you have the [prerequisites installed](serve-docs-locally#prerequisites), running a local instance of Docusaurus takes three steps:
 
 1. Fork/Clone the [meshtastic/Meshtastic](https://github.com/meshtastic/Meshtastic) repository and navigate to the root directory of the project.
 ```bash title="Clone the project"

docusaurus.config.js

@@ -70,8 +70,8 @@ const config = {
               to: "docs/developers",
             },
             {
-              label: "About this Documentation",
-              to: "docs/about-documentation",
+              label: "Maintaining Documentation",
+              to: "docs/developers/maintaining-documentation/overview",
             },
             {
               label: "Legal",
@@ -108,10 +108,10 @@ const config = {
               label: 'Getting Started',
               to: 'docs/getting-started',
             },
-            {
-              label: 'About',
-              to: 'docs/about-documentation',
-            },
+            // {
+            //   label: 'About',
+            //   to: 'docs/about',
+            // },
             {
               label: 'Hardware',
               to: 'docs/hardware',
@@ -167,6 +167,10 @@ const config = {
               label: 'GitHub',
               to: 'https://github.com/meshtastic',
             },
+            {
+              label: 'Contribute',
+              to: 'docs/developers',
+            },
           ],
         },
       ],

sidebars.js

@@ -100,7 +100,7 @@ module.exports = {
       {type: "ref", id: "settings/overview"},
       {type: "ref", id: "hardware/overview"},
       {type: "ref", id: "developers/overview"},
-      {type: "ref", id: "about-documentation/overview"},
+      {type: "ref", id: "developers/maintaining-documentation/overview"},
       {type: "ref", id: "legal/overview"},
     ],
   },
@@ -156,7 +156,7 @@ module.exports = {
       {type: "ref", id: "hardware/overview"},
       {type: "ref", id: "software/overview"},
       {type: "ref", id: "developers/overview"},
-      {type: "ref", id: "about-documentation/overview"},
+      {type: "ref", id: "developers/maintaining-documentation/overview"},
       {type: "ref", id: "legal/overview"},
     ],
   },
@@ -190,12 +190,12 @@ module.exports = {
       {type: "ref", id: "settings/overview"},
       {type: "ref", id: "software/overview"},
       {type: "ref", id: "developers/overview"},
-      {type: "ref", id: "about-documentation/overview"},
+      {type: "ref", id: "developers/maintaining-documentation/overview"},
       {type: "ref", id: "legal/overview"},
     ],
   },
   Contribute: {
-    Developers: [
+    "Contribute to Meshtastic": [
       "developers/overview",
       {
         Protobufs: ["developers/protobufs/api"],
@@ -220,25 +220,25 @@ module.exports = {
           "developers/android/build-app",
           "developers/android/mapbox",
         ],
-      },
-    ],
-    "Maintaining Documentation": [
-      "about-documentation/overview",
-      {
-        Dependencies: [
-          "about-documentation/docusaurus",
-          "about-documentation/github",
-          "about-documentation/vercel",
-        ],
-      },
-      {
-        Examples: [
-          "about-documentation/serve-docs-locally",
-        ],
-      },
-      {
-        "Style Guides": [
-          "about-documentation/style-guides/style-guide-settings",
+        "Maintaining Documentation": [
+          "developers/maintaining-documentation/overview",
+          {
+            Dependencies: [
+              "developers/maintaining-documentation/docusaurus",
+              "developers/maintaining-documentation/github",
+              "developers/maintaining-documentation/vercel",
+            ],
+          },
+          {
+            Examples: [
+              "developers/maintaining-documentation/serve-docs-locally",
+            ],
+          },
+          {
+            "Style Guides": [
+              "developers/maintaining-documentation/style-guides/style-guide-settings",
+            ],
+          },
         ],
       },
     ],