mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Developer docs fixes

Browse source
This commit is contained in:
Sacha Weatherstone 2022-10-31 19:07:44 +10:00
parent 848987cffa
commit 0169a8b71d
No known key found for this signature in database
GPG key ID: 7AB2D7E206124B31
2 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/developers/Firmware/build.mdx
View file

@ -10,9 +10,9 @@ Meshtastic uses the [PlatformIO](https://platformio.org) development environment
1. Install PlatformIO, following the instructions available [here](https://platformio.org/platformio-ide). 1. Install PlatformIO, following the instructions available [here](https://platformio.org/platformio-ide).
2. Clone the `firmware` repository located [here](https://github.com/meshtastic/firmware). ([Instructions on cloning](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)) 2. Clone the [`firmware`](https://github.com/meshtastic/firmware) repository. ([Instructions on cloning](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
3. Clone the [Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) 3. Clone the repositories [Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
```shell ```shell
git submodule update --init git submodule update --init
@ -61,7 +61,7 @@ The build system is modular. Adding a new board variant for an already supported
1. do all of the above until your hardware runs fine 1. do all of the above until your hardware runs fine
2. [Send in a proposal to add a new board](https://github.com/meshtastic/firmware/issues/new?assignees=&labels=enhancement%2Ctriage&template=New+Board.yml&title=%5BBoard%5D%3A+) 2. [Send in a proposal to add a new board](https://github.com/meshtastic/firmware/issues/new?assignees=&labels=enhancement%2Ctriage&template=New+Board.yml&title=%5BBoard%5D%3A+)
3. if approved, go to (https://github.com/meshtastic/protobufs) and send a Pull Request for the mesh.proto file, adding your board to the HardwareModel enum. 3. if approved, go to (https://github.com/meshtastic/protobufs) and send a Pull Request for the `mesh.proto` file, adding your board to the `HardwareModel` Enum.
4. change your define in `platformio.ini` from `PRIVATE_HW` to `YOUR_BOARD`. Adjust any macro guards in the code you need to support your board. 4. change your define in `platformio.ini` from `PRIVATE_HW` to `YOUR_BOARD`. Adjust any macro guards in the code you need to support your board.
5. add your board identifier to `configuration.h` on the firmware repo and send in that Pull Request too. 5. add your board identifier to `configuration.h` on the firmware repo and send in that Pull Request too.
6. wait for the Pulls to be merged back into Master. 6. wait for the Pulls to be merged back into Master.

24
docs/developers/documentation/serve-docs-locally.mdx
View file

@ -5,55 +5,55 @@ sidebar_label: Serve Docs Locally
--- ---
:::note :::note
Some things won't display properly like logos or protobufs, this is not cause for concern. Some things won't display properly like logos or protobufs page, this is not cause for concern.
::: :::
## Prerequisites ## Prerequisites
In order to set up your local environment, you will need to install: 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) - [Node.js Runtime](https://nodejs.org)
- [Yarn package manager](https://yarnpkg.com/getting-started/install) - [PNPM Package Manager](https://pnpm.io)
## Getting Started ## Getting Started
### Fork the Meshtastic Repository ### Fork the Meshtastic Repository
Log into Github and create a fork of the [meshtastic/meshtastic](https://github.com/meshtastic/meshtastic) repository. Log into GitHub and create a fork of the [meshtastic/meshtastic](https://github.com/meshtastic/meshtastic) repository.
### Clone your Meshtastic Repository fork ### Clone your Meshtastic Repository fork
:::note :::note
Replace `username` with your Github username. Replace `username` with your GitHub username.
::: :::
```shell title="Clone username/Meshtastic Repo" ```shell title="Clone username/Meshtastic Repo"
git clone https://github.com/username/Meshtastic.git git clone https://github.com/username/meshtastic.git
``` ```
### Change directory to Local copy ### Change directory to Local copy
```shell title="Change Directory" ```shell title="Change Directory"
cd ~/Meshtastic cd ~/meshtastic
``` ```
### Install Dependencies ### Install Dependencies
```shell title="Install dependencies using Yarn" ```shell title="Install dependencies using Yarn"
yarn install pnpm i
``` ```
### Run Development Server ### Run Development Server
```shell title="Run node.js server" ```shell title="Run node.js server"
yarn start pnpm start
``` ```
:::tip :::tip
Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors: Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors:
```shell title="Build Project" ```shell title="Build Project"
yarn build pnpm build
``` ```
::: :::
@ -70,13 +70,13 @@ If it's set, skip to [Align with meshtastic/meshtastic Master branch](#align-wit
#### Update/Set Upstream if it isn't configured properly #### Update/Set Upstream if it isn't configured properly
If upstream exists, set the url: If upstream exists, set the URL:
```shell title="Update Upstream Repository" ```shell title="Update Upstream Repository"
git remote set-url upstream https://github.com/meshtastic/meshtastic.git git remote set-url upstream https://github.com/meshtastic/meshtastic.git
``` ```
If upstream doesn't exist, add the url: If upstream doesn't exist, add the URL:
```shell title="Add Upstream Repository" ```shell title="Add Upstream Repository"
git remote add upstream https://github.com/meshtastic/meshtastic.git git remote add upstream https://github.com/meshtastic/meshtastic.git