meshtastic/docs/developers/maintaining-documentation/serve-docs-locally.md

id	title	sidebar_label
serve-docs-locally	Setting up Local Documentation	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)
• Yarn package manager

Getting Started

Fork the Meshtastic Repository

Log into Github and create a fork of the meshtastic/Meshtastic repository.

Clone your Meshtastic Repository fork

:::note Replace username with your Github username. :::

git clone https://github.com/username/Meshtastic.git

Change directory to Local copy

cd ~/Meshtastic

Install Dependencies

yarn install

Run Development 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:

yarn build

:::

Update Local Repository

Verify Upstream Remote is Set

git remote -v

If it's set, skip to Align with meshtastic/Meshtastic Master branch

Update/Set Upstream if it isn't configured properly

If upstream exists, set the url:

git remote set-url upstream https://github.com/meshtastic/Meshtastic.git

If upstream doesn't exist, add the url:

git remote add upstream https://github.com/meshtastic/Meshtastic.git

Align with meshtastic/Meshtastic Master branch

:::caution This will delete any unfinished work. Make sure that you've saved and committed any work you wish to push up to your fork. :::

:::info The following command assumes the clone of your Meshtastic fork is in the home directory (~/Meshtastic). Adjust the path to the correct path on your machine. :::

cd ~/Meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master