From 59df0872a7d991c524467dab39853b2befd7d9a2 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 06:33:51 -0700 Subject: [PATCH] added header and tip --- docs/about-documentation/serve-docs-locally.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/about-documentation/serve-docs-locally.md b/docs/about-documentation/serve-docs-locally.md index 92b3d566..54875c21 100644 --- a/docs/about-documentation/serve-docs-locally.md +++ b/docs/about-documentation/serve-docs-locally.md @@ -12,6 +12,7 @@ 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) +## Getting Started ### Fork the Meshtastic Repository Log into Github and create a fork of the [meshtastic/Meshtastic](https://github.com/meshtastic/Meshtastic) repository. @@ -40,3 +41,11 @@ yarn install ```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 +``` +:::