From f92647ef24d4bb52bcda19c99ced9484e596b8de Mon Sep 17 00:00:00 2001 From: Sacha Weatherstone Date: Wed, 9 Mar 2022 18:51:46 +1100 Subject: [PATCH] Format with prettier --- docs/about/concepts/clients.md | 1 + docs/about/concepts/overview.md | 1 + docs/about/overview.md | 2 + docs/academy/academy.md | 2 +- docs/developers/android/mapbox.md | 6 +- docs/developers/device/device-api.md | 22 +- docs/developers/device/port-numbers.md | 12 +- docs/developers/device/radio-settings.md | 38 +- .../maintaining-documentation/docusaurus.md | 3 + .../maintaining-documentation/github.md | 3 + .../maintaining-documentation/overview.md | 33 +- .../serve-docs-locally.md | 8 + .../style-guides/settings.md | 82 +-- .../maintaining-documentation/vercel.md | 2 + docs/faq/antenna.md | 1 + docs/faq/channel.md | 1 + docs/faq/client-android.md | 1 + docs/faq/client-python-cli.md | 1 + docs/faq/client-web.md | 1 + docs/faq/mesh.md | 1 + docs/faq/mqtt.md | 1 + docs/faq/wifi.md | 1 + docs/getting-started/clients.md | 8 +- docs/getting-started/first-steps.md | 1 + docs/getting-started/flashing-firmware.md | 54 +- docs/getting-started/getting_started.md | 1 + docs/getting-started/meshtastic-flasher.md | 118 ++-- docs/hardware/antenna/aerials.md | 11 +- docs/hardware/antenna/antenna.md | 14 +- docs/hardware/antenna/non-aerial.md | 2 + docs/hardware/overview.md | 3 +- docs/hardware/supported/lora.md | 2 - docs/hardware/supported/tbeam.md | 3 - docs/legal/licensing.md | 1 + docs/legal/overview.md | 5 +- docs/legal/trademark.md | 1 + docs/settings/channel-advanced.md | 138 ++--- docs/settings/gps.md | 513 +++++++++--------- docs/settings/ham.md | 46 +- docs/settings/misc.md | 200 +++---- docs/settings/overview.md | 27 +- docs/settings/power.md | 507 ++++++++--------- docs/settings/router.md | 63 +-- docs/settings/wifi.md | 206 +++---- docs/software/community/go.md | 1 + docs/software/community/overview.md | 7 +- docs/software/device/critical-faults.md | 22 +- docs/software/device/ham.md | 11 +- docs/software/device/power.md | 32 +- docs/software/ios/development.md | 8 +- docs/software/js/connecting.md | 13 +- docs/software/js/http-api.md | 12 +- docs/software/modules/modules.md | 14 +- docs/software/other/esp32-arduino-build.md | 7 +- docs/software/python/cli.md | 2 +- docs/software/python/standalone.md | 66 +-- docs/software/python/using_library.md | 8 +- docs/software/web/development.md | 13 +- package.json | 4 +- yarn.lock | 5 + 60 files changed, 1261 insertions(+), 1111 deletions(-) diff --git a/docs/about/concepts/clients.md b/docs/about/concepts/clients.md index 6f91b73b..bf30fe43 100644 --- a/docs/about/concepts/clients.md +++ b/docs/about/concepts/clients.md @@ -3,6 +3,7 @@ id: clients title: Clients sidebar_label: Clients --- + ## Overview ## Available Clients diff --git a/docs/about/concepts/overview.md b/docs/about/concepts/overview.md index 18270746..6a70235a 100644 --- a/docs/about/concepts/overview.md +++ b/docs/about/concepts/overview.md @@ -3,4 +3,5 @@ id: overview title: Meshtastic Concepts sidebar_label: Concepts Overview --- + ## Overview diff --git a/docs/about/overview.md b/docs/about/overview.md index 56830530..71f09364 100644 --- a/docs/about/overview.md +++ b/docs/about/overview.md @@ -4,6 +4,7 @@ title: About Meshtastic sidebar_label: About Meshtastic slug: /about --- + :::info This section is new and is still being developed. If you'd like to contribute, please do! ::: @@ -25,6 +26,7 @@ When a receiving radio captures a packet, it checks to see if it has heard that For each message a radio rebroadcasts, it marks the "hop limit" down by one. When a radio receives a packet with a hop limit of zero, it will not rebroadcast the message. ## Who develops Meshtastic + Meshtastic is an open source project available on GitHub. Our generous volunteers donate their personal time to write and maintain this codebase. If you would like to contribute see our [GitHub](https://github.com/meshtastic), join our [Discord server](https://discord.com/invite/UQJ5QuM7vq), and read up on our [forum](https://meshtastic.discourse.group). diff --git a/docs/academy/academy.md b/docs/academy/academy.md index 19a422c2..68ca185c 100644 --- a/docs/academy/academy.md +++ b/docs/academy/academy.md @@ -12,4 +12,4 @@ I want something that just works. Tinkerer -Maker \ No newline at end of file +Maker diff --git a/docs/developers/android/mapbox.md b/docs/developers/android/mapbox.md index 66ad6b87..252d22f9 100644 --- a/docs/developers/android/mapbox.md +++ b/docs/developers/android/mapbox.md @@ -12,9 +12,9 @@ In order to compile a new version of Meshtastic that can use MapBox you will nee This is fairly simple to do. -* Create an account at MapBox -* Copy the public token associated with that account to the clipboard -* Paste that into the file "…/src/main/res/values/mapbox-token.xml" +- Create an account at MapBox +- Copy the public token associated with that account to the clipboard +- Paste that into the file "…/src/main/res/values/mapbox-token.xml" ## Examples of what can be achieved with MapBox diff --git a/docs/developers/device/device-api.md b/docs/developers/device/device-api.md index affe865a..86fb7b4a 100644 --- a/docs/developers/device/device-api.md +++ b/docs/developers/device/device-api.md @@ -82,7 +82,7 @@ When the ESP32 advances fromnum, it will delay doing the notify by 100ms, in the Note: that if the phone ever sees this number decrease, it means the ESP32 has rebooted. -Re: Queue management, +Re: Queue management, not all messages are kept in the fromradio queue (filtered based on SubPacket): - only the most recent Position and User messages for a particular node are kept @@ -111,16 +111,16 @@ SoftwareUpdateService UUID cb0b9a0b-a84c-4c0d-bdbb-442e3144ee30 Characteristics -| UUID | properties | description | -| ------------------------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------- | -| e74dd9c0-a301-4a6f-95a1-f0e1dbea8e1e | write,read | total image size, 32 bit, write this first, then read back to see if it was acceptable (0 mean not accepted) | -| e272ebac-d463-4b98-bc84-5cc1a39ee517 | write | data, variable sized, recommended 512 bytes, write one for each block of file | -| 4826129c-c22a-43a3-b066-ce8f0d5bacc6 | write | crc32, write last - writing this will complete the OTA operation, now you can read result | -| 5e134862-7411-4424-ac4a-210937432c77 | read,notify | result code, readable but will notify when the OTA operation completes | -| 5e134862-7411-4424-ac4a-210937432c67 | write | sets the region for programming, currently only 0 (app) or 100 (spiffs) are defined, if not set app is assumed | -| GATT_UUID_SW_VERSION_STR/0x2a28 | read | We also implement these standard GATT entries because SW update probably needs them: | -| GATT_UUID_MANU_NAME/0x2a29 | read | | -| GATT_UUID_HW_VERSION_STR/0x2a27 | read | | +| UUID | properties | description | +| ------------------------------------ | ----------- | -------------------------------------------------------------------------------------------------------------- | +| e74dd9c0-a301-4a6f-95a1-f0e1dbea8e1e | write,read | total image size, 32 bit, write this first, then read back to see if it was acceptable (0 mean not accepted) | +| e272ebac-d463-4b98-bc84-5cc1a39ee517 | write | data, variable sized, recommended 512 bytes, write one for each block of file | +| 4826129c-c22a-43a3-b066-ce8f0d5bacc6 | write | crc32, write last - writing this will complete the OTA operation, now you can read result | +| 5e134862-7411-4424-ac4a-210937432c77 | read,notify | result code, readable but will notify when the OTA operation completes | +| 5e134862-7411-4424-ac4a-210937432c67 | write | sets the region for programming, currently only 0 (app) or 100 (spiffs) are defined, if not set app is assumed | +| GATT_UUID_SW_VERSION_STR/0x2a28 | read | We also implement these standard GATT entries because SW update probably needs them: | +| GATT_UUID_MANU_NAME/0x2a29 | read | | +| GATT_UUID_HW_VERSION_STR/0x2a27 | read | | #### DeviceInformationService diff --git a/docs/developers/device/port-numbers.md b/docs/developers/device/port-numbers.md index 4d53ba9d..13f5d1eb 100644 --- a/docs/developers/device/port-numbers.md +++ b/docs/developers/device/port-numbers.md @@ -6,13 +6,13 @@ sidebar_label: Port numbers For any new apps that run on the device or via sister apps on phones/PCs they should pick and use a unique 'portnum' for their application. -If you are making a new app using meshtastic, please send in a pull request to add your 'portnum' to this master table. PortNums should be assigned in the following range: +If you are making a new app using meshtastic, please send in a pull request to add your 'portnum' to this master table. PortNums should be assigned in the following range: -| Portnum | Usage | -| --- | --- | -| 0-63 | Core Meshtastic use, do not use for third party apps | -| 64-127 | Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application | -| 256-511 | Use one of these portnums for your private applications that you do not want to register publicly | +| Portnum | Usage | +| ------- | ---------------------------------------------------------------------------------------------------------------------- | +| 0-63 | Core Meshtastic use, do not use for third party apps | +| 64-127 | Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application | +| 256-511 | Use one of these portnums for your private applications that you do not want to register publicly | All other values are reserved. diff --git a/docs/developers/device/radio-settings.md b/docs/developers/device/radio-settings.md index 7dba5ccb..fbeefdc5 100644 --- a/docs/developers/device/radio-settings.md +++ b/docs/developers/device/radio-settings.md @@ -59,14 +59,14 @@ Considerations: We have six predefined channels. These are the most common settings and have been proven to work well: -| Channel setting | Alt Channel Name | Data-rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget | -| :------------------------- | :--------------- | :------------------- | :----------- | :---------- | :-------- | :---------- | -| Short Range / Fast | Short Fast | 18.89 kbps | 7 / 128 | 4/5 | 500 | 134dB | -| Short Range / Slow | Short Slow | 4.69 kbps | 7 / 128 | 4/5 | 125 | 140dB | -| Medium Range / Fast | Medium Fast | 1.2 kbps | 10 / 1024 | 4/6 | 250 | 146dB | -| Medium Range / Slow | Medium Slow | 0.75 kbps | 11 / 2048 | 4/7 | 250 | 148dB | -| Long Range / Fast | Long Fast | 0.19 kbps | 9 / 512 | 4/8 | 31 | 153dB | -| Long Range / Slow | Long Slow | 0.13 kbps (default) | 12 / 4096 | 4/8 | 125 | 154dB | +| Channel setting | Alt Channel Name | Data-rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget | +| :------------------ | :--------------- | :------------------ | :----------- | :---------- | :-------- | :---------- | +| Short Range / Fast | Short Fast | 18.89 kbps | 7 / 128 | 4/5 | 500 | 134dB | +| Short Range / Slow | Short Slow | 4.69 kbps | 7 / 128 | 4/5 | 125 | 140dB | +| Medium Range / Fast | Medium Fast | 1.2 kbps | 10 / 1024 | 4/6 | 250 | 146dB | +| Medium Range / Slow | Medium Slow | 0.75 kbps | 11 / 2048 | 4/7 | 250 | 148dB | +| Long Range / Fast | Long Fast | 0.19 kbps | 9 / 512 | 4/8 | 31 | 153dB | +| Long Range / Slow | Long Slow | 0.13 kbps (default) | 12 / 4096 | 4/8 | 125 | 154dB | Note: The link budget used by these calculations assumes a transmit power of 17dBm and an antenna with 0dB gain. Adjust your link budget assumptions based on your actual devices. Data-rate in this table is actual measured but doesn't count mesh overhead, hops and retransmissions. @@ -82,17 +82,17 @@ After applying the settings, you will need to restart the device. After your dev Some example settings: -| Data-rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget | Note | -| :--------- | :----------- | :---------- | :-------- | :---------- | :---------------------------------------------------------------------- | -| 37.50 kbps | 6 / 64 | 4/5 | 500 | 129dB | Fastest possible speed | -| 3.125 kbps | 8 / 256 | 4/5 | 125 | 143dB | | -| 1.953 kbps | 8 / 256 | 4/8 | 125 | 143dB | | -| 1.343 kbps | 11 / 2048 | 4/8 | 500 | 145dB | | -| 1.099 kbps | 9 / 512 | 4/8 | 125 | 146dB | | -| 0.814 kbps | 10 / 1024 | 4/6 | 125 | 149dB | | -| 0.610 kbps | 10 / 1024 | 4/8 | 125 | 149dB | | -| 0.488 kbps | 11 / 2048 | 4/6 | 125 | 152dB | | -| 0.336 kbps | 11 / 2048 | 4/8 | 125 | 152dB | | +| Data-rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget | Note | +| :--------- | :----------- | :---------- | :-------- | :---------- | :----------------------------------------------------------------------- | +| 37.50 kbps | 6 / 64 | 4/5 | 500 | 129dB | Fastest possible speed | +| 3.125 kbps | 8 / 256 | 4/5 | 125 | 143dB | | +| 1.953 kbps | 8 / 256 | 4/8 | 125 | 143dB | | +| 1.343 kbps | 11 / 2048 | 4/8 | 500 | 145dB | | +| 1.099 kbps | 9 / 512 | 4/8 | 125 | 146dB | | +| 0.814 kbps | 10 / 1024 | 4/6 | 125 | 149dB | | +| 0.610 kbps | 10 / 1024 | 4/8 | 125 | 149dB | | +| 0.488 kbps | 11 / 2048 | 4/6 | 125 | 152dB | | +| 0.336 kbps | 11 / 2048 | 4/8 | 125 | 152dB | | | 0.073 kbps | 12 / 4096 | 4/5 | 31 | 160dB | Twice the range and/or coverage of "Long Slow", low resilience to noise | | 0.046 kbps | 12 / 4096 | 4/8 | 31 | 160dB | Twice the range and/or coverage of "Long Slow", high resilience to noise | diff --git a/docs/developers/maintaining-documentation/docusaurus.md b/docs/developers/maintaining-documentation/docusaurus.md index 320ba184..f41d3e4d 100644 --- a/docs/developers/maintaining-documentation/docusaurus.md +++ b/docs/developers/maintaining-documentation/docusaurus.md @@ -3,8 +3,11 @@ id: docusaurus title: Docusaurus sidebar_label: Docusaurus --- + ## Overview + Meshtastic's documentation is set up using [Docusaurus](https://docusaurus.io). It is highly encouraged to look at [their documentation](https://docusaurus.io/docs) when looking for a solution to a problem with our docs. They most likely have thought of the use case you've discovered. ## Known Issues + - Admonitions within a `TabItem` component need to be completely unindented to show up correctly. diff --git a/docs/developers/maintaining-documentation/github.md b/docs/developers/maintaining-documentation/github.md index a9762051..dc56777e 100644 --- a/docs/developers/maintaining-documentation/github.md +++ b/docs/developers/maintaining-documentation/github.md @@ -3,9 +3,12 @@ id: github title: GitHub sidebar_label: GitHub --- + ## Overview + All of Meshtastic's code and documentation is hosted on GitHub. If you would like to contribute to the project, having a GitHub account is an important step to doing so. ## Set up GitHub account + - Go to [github.com](https://github.com) - Click `Sign Up` diff --git a/docs/developers/maintaining-documentation/overview.md b/docs/developers/maintaining-documentation/overview.md index 0e42b89a..e71c5046 100644 --- a/docs/developers/maintaining-documentation/overview.md +++ b/docs/developers/maintaining-documentation/overview.md @@ -3,9 +3,11 @@ id: overview title: Maintaining Documentation sidebar_label: Maintaining 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 + All of our documentation resides on GitHub. Instructions for setting up your GitHub account are located [here](github). 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. Instructions for setting up your instance of Docusaurus are located [here](docusaurus). @@ -13,37 +15,45 @@ Our documentation is powered by [Docusaurus](https://docusaurus.io) — a docume Another component that we use is [Vercel](https://vercel.com) — a platform for frontend frameworks and static sites. Instructions for setting up your instance of Vercel are located [here](vercel). ## Documentation Organization -| Section | File Path | Description | -| :-----: | :-------: | :---------: | -| About Meshtastic | `docs/about` | High level explanation of of Meshtastic. | -| Meshtastic Software | `docs/software` | Current bulk of documentation running through each Meshtastic project. | -| 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/maintaining-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. | + +| Section | File Path | Description | +| :----------------------: | :------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| About Meshtastic | `docs/about` | High level explanation of of Meshtastic. | +| Meshtastic Software | `docs/software` | Current bulk of documentation running through each Meshtastic project. | +| 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/maintaining-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](serve-docs-locally#prerequisites), 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 ``` @@ -54,4 +64,5 @@ Before submitting a pull request, it's helpful to run the following command to e ```bash title="Build Project" yarn build ``` + ::: diff --git a/docs/developers/maintaining-documentation/serve-docs-locally.md b/docs/developers/maintaining-documentation/serve-docs-locally.md index 54875c21..1d7d9520 100644 --- a/docs/developers/maintaining-documentation/serve-docs-locally.md +++ b/docs/developers/maintaining-documentation/serve-docs-locally.md @@ -3,16 +3,20 @@ 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) ## Getting Started + ### Fork the Meshtastic Repository Log into Github and create a fork of the [meshtastic/Meshtastic](https://github.com/meshtastic/Meshtastic) repository. @@ -28,16 +32,19 @@ 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 ``` @@ -48,4 +55,5 @@ Before submitting a pull request, it's helpful to run the following command to e ```bash title="Build Project" yarn build ``` + ::: diff --git a/docs/developers/maintaining-documentation/style-guides/settings.md b/docs/developers/maintaining-documentation/style-guides/settings.md index d7d0ec9e..ad7ec6c0 100644 --- a/docs/developers/maintaining-documentation/style-guides/settings.md +++ b/docs/developers/maintaining-documentation/style-guides/settings.md @@ -3,41 +3,50 @@ id: style-guide-settings title: Style Guide - Settings Pages sidebar_label: Settings Pages --- + ## Overview + Setting pages should focus solely on settings and configuring the device. Hardware is often a related topic, however these pages should not attempt to explain attaching hardware. Mention that hardware is required and link to the appropriate page(s). ## Layout ### Overview + This section should describe the group of settings and what they do for the device. ### Settings + This section starts with an alphabetized table of settings, available values, and default values. Available values should be listed with tick marks `` surrounding the value. -| Value Type | Example | -| :--------: | :-----: | -| Boolean | `true`, `false` | -| List | `apple`, `banana`, `orange` | -| Range | `0`-`100` | +| Value Type | Example | +| :--------: | :-------------------------: | +| Boolean | `true`, `false` | +| List | `apple`, `banana`, `orange` | +| Range | `0`-`100` | After the table each setting is described in brief detail. If the available options for a setting need additional explanation, a table should be used to describe each available option. ### Details + If additional details are needed, this optional section can explain that. These would include prerequisites, links to hardware guides, etc. ### Examples -This optional section can have examples of configurations needed where multiple settings are required to be set up for a specific use case. + +This optional section can have examples of configurations needed where multiple settings are required to be set up for a specific use case. ## Example Template + ```markdown title="Template for Settings Pages" --- id: unique-id title: Title for Page sidebar_label: Label for Sidebar --- + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -48,48 +57,55 @@ import TabItem from '@theme/TabItem'; ## Settings -| Setting | Acceptable Values | Default | -| :-----: | :---------------: | :-----: | + +| Setting | Acceptable Values | Default | +| :---------------------: | :-------------------------: | :-----: | | my_setting_with_options | `apple`, `banana`, `orange` | `apple` | + ### my_setting_with_options + -| Value | Description | -| :---: | :---------: | -| `apple` | Description of apple (default) | -| `banana` | Description of banana | -| `orange` | Description of orange | + +| Value | Description | +| :------: | :----------------------------: | +| `apple` | Description of apple (default) | +| `banana` | Description of banana | +| `orange` | Description of orange | + - - CLI content here - - - Android content here - - - iOS content here - - - Web content here - +groupId="settings" +defaultValue="cli" +values={[ +{label: 'CLI', value: 'cli'}, +{label: 'Android', value: 'android'}, +{label: 'iOS', value: 'iOS'}, +{label: 'Web', value: 'web'}, +]}> + +CLI content here + + +Android content here + + +iOS content here + + +Web content here + ## Details + ## Examples + ``` diff --git a/docs/developers/maintaining-documentation/vercel.md b/docs/developers/maintaining-documentation/vercel.md index 0a54dff9..a0e3c3f9 100644 --- a/docs/developers/maintaining-documentation/vercel.md +++ b/docs/developers/maintaining-documentation/vercel.md @@ -3,7 +3,9 @@ id: vercel title: Vercel sidebar_label: Vercel --- + ## Overview + Setting up a Vercel account is an optional step that can help you view your changes to the documentation in a server environment just like the actual docs. This can be helpful to include when submitting a pull request so that developers can review your changes and visually check that things look correct. ## Set up Vercel account diff --git a/docs/faq/antenna.md b/docs/faq/antenna.md index f8136b14..18e3f6f9 100644 --- a/docs/faq/antenna.md +++ b/docs/faq/antenna.md @@ -3,4 +3,5 @@ id: antenna title: FAQs - Antenna sidebar_label: Antenna --- + ## Overview diff --git a/docs/faq/channel.md b/docs/faq/channel.md index eadb1888..9bdcfb12 100644 --- a/docs/faq/channel.md +++ b/docs/faq/channel.md @@ -3,6 +3,7 @@ id: channel title: FAQs - Channel sidebar_label: Channel --- + ## Overview ### What is a Meshtastic Channel? diff --git a/docs/faq/client-android.md b/docs/faq/client-android.md index c8f2d21c..8696d1e5 100644 --- a/docs/faq/client-android.md +++ b/docs/faq/client-android.md @@ -3,6 +3,7 @@ id: client-android title: FAQs - Android sidebar_label: Android --- + ## Overview ### What versions of Android does the Meshtastic Android App require? diff --git a/docs/faq/client-python-cli.md b/docs/faq/client-python-cli.md index a5bb0d9b..f9beb149 100644 --- a/docs/faq/client-python-cli.md +++ b/docs/faq/client-python-cli.md @@ -3,6 +3,7 @@ id: client-python-cli title: FAQs - CLI sidebar_label: CLI --- + ## Overview ### How do I find out more about installing (and using) Meshtastic via command line? diff --git a/docs/faq/client-web.md b/docs/faq/client-web.md index 92c9a14f..0f9ec468 100644 --- a/docs/faq/client-web.md +++ b/docs/faq/client-web.md @@ -3,6 +3,7 @@ id: client-web title: FAQs - Web sidebar_label: Web --- + ## Overview ### How do I access the network from my web browser? diff --git a/docs/faq/mesh.md b/docs/faq/mesh.md index 5b88621b..055b4b10 100644 --- a/docs/faq/mesh.md +++ b/docs/faq/mesh.md @@ -3,4 +3,5 @@ id: mesh title: FAQs - Mesh sidebar_label: Mesh --- + ## Overview diff --git a/docs/faq/mqtt.md b/docs/faq/mqtt.md index 4264f5e2..9b88f851 100644 --- a/docs/faq/mqtt.md +++ b/docs/faq/mqtt.md @@ -3,4 +3,5 @@ id: mqtt title: FAQs - MQTT sidebar_label: MQTT --- + ## Overview diff --git a/docs/faq/wifi.md b/docs/faq/wifi.md index 51990bc6..2becf7dd 100644 --- a/docs/faq/wifi.md +++ b/docs/faq/wifi.md @@ -3,6 +3,7 @@ id: wifi title: FAQs - WiFi sidebar_label: WiFi --- + ## Overview ### How do I turn on the WiFI radio? diff --git a/docs/getting-started/clients.md b/docs/getting-started/clients.md index e8fe5cfd..4c86be0c 100644 --- a/docs/getting-started/clients.md +++ b/docs/getting-started/clients.md @@ -3,7 +3,8 @@ id: clients title: Meshtastic Clients sidebar_label: Meshtastic Clients --- -import { DownloadCard } from '/src/pages/downloads/_components/DownloadCard.tsx' + +import { DownloadCard } from '/src/pages/downloads/\_components/DownloadCard.tsx' ## Overview @@ -20,14 +21,17 @@ To install/upgrade Meshtastic-python manually, see below: ```bash title="Install Meshtastic-python (includes CLI)" pip install meshtastic ``` + ```bash title="Upgrade Meshtastic-python (includes CLI)" pip install --upgrade meshtastic ``` + :::note Some installations of python may require you to substitute 'pip3' for the 'pip' command. ::: ### Mobile Client Downloads +