Merge pull request #221 from jfirwin/about-documentation

initial about documentation pages

docs/about-documentation/overview.md

@@ -0,0 +1,24 @@
+---
+id: overview
+title: Overview
+sidebar_label: Overview
+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
+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.
+
+Another component that we use is [Vercel](https://vercel.com) — a platform for frontend frameworks and static sites.
+
+## Documentation Organization
+| Section | File Path | Description |
+| :-----: | :-------: | :---------: |
+| About Meshtastic | `docs/software` | High level explanation of each part of Meshtastic. |
+| Getting Started | `docs/getting-started` | Instructions on how to get the Meshtastic firmware onto a users device. |
+| Device Settings | `docs/software/settings` | Details each user setting and provides explanations for what the setting does and how to configure the device using the various clients available (Android, CLI, iOS, Web) |
+| 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. |
+| 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. |

docs/about-documentation/serve-docs-locally.md

@@ -0,0 +1,42 @@
+---
+id: serve-docs-locally
+title: Setting up Local Documentation
+sidebar_label: Serve Docs Locally
+---
+:::note
+Some things won't display properly like logos or protobufs, this is not cause for concern.
+:::
+## Prerequisites
+In order to set up your local environment, you will need to install:
+
+- [Node & Node package manager (NPM)](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [Yarn package manager](https://yarnpkg.com/getting-started/install)
+
+### Fork the Meshtastic Repository
+
+Log into Github and create a fork of the [meshtastic/Meshtastic](https://github.com/meshtastic/Meshtastic) repository.
+
+### Clone your Meshtastic Repository fork
+
+:::note
+Replace `username` with your Github username.
+:::
+
+```bash title="Clone username/Meshtastic Repo"
+git clone https://github.com/username/Meshtastic.git
+```
+
+### Change directory to Local copy
+```bash title="Change Directory"
+cd ~/Meshtastic
+```
+
+### Install Dependencies
+```bash title="Install dependencies using Yarn"
+yarn install
+```
+
+### Run Development Server
+```bash title="Run node.js server"
+yarn start
+```

docusaurus.config.js

@@ -57,13 +57,10 @@ const config = {
               label: "Contribute to Meshtastic",
               to: "docs/developers",
             },
-            /*
-              TODO add Docusaurus and Vercel instructions for how to manage the docs
             {
               label: "About this Documentation",
               to: "docs/about-documentation",
             },
-            */
             {
               label: "Legal",
               to: "docs/legal",

sidebars.js

@@ -193,6 +193,12 @@ module.exports = {
       },
     ],
   },
+  Documentation: {
+    "About Documentation": [
+      "about-documentation/overview",
+      "about-documentation/serve-docs-locally",
+    ]
+  },
   Legal: {
     Legal: [
       "legal/overview",