From 649f8abf97d919b0f1fcce48877f0a2c7d0e600c Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 05:51:44 -0700 Subject: [PATCH] added quickstart to docs editing --- docs/about-documentation/overview.md | 31 ++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/about-documentation/overview.md b/docs/about-documentation/overview.md index 72f271d0..04f3338f 100644 --- a/docs/about-documentation/overview.md +++ b/docs/about-documentation/overview.md @@ -22,3 +22,34 @@ Another component that we use is [Vercel](https://vercel.com) — a platform for | 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. | + +## Quick Start + +Assuming you have the prerequisites installed, 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" +git clone https://github.com/meshtastic/Meshtastic.git +``` +```bash title="Clone fork of the project" +git clone https://github.com/[username]/Meshtastic.git +``` +```bash title="Change Directory" +cd ~/Meshtastic +``` +2. Install Dependencies +```bash title="Install dependencies using Yarn" +yarn install +``` +3. Run Docusaurus +```bash title="Run node.js server" +yarn start +``` + +:::tip +Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors: + +```bash title="Build Project" +yarn build +``` +:::