moved dev docs out of software page

This commit is contained in:
sigmahour 2022-11-02 17:50:50 -04:00
parent 0081e4201f
commit e8384909b8
40 changed files with 181 additions and 199 deletions

View file

@ -37,7 +37,7 @@ The [meshtastic/Meshtastic-python](https://github.com/meshtastic/Meshtastic-pyth
## Web Application
The [meshtastic/web](https://github.com/meshtastic/web) repository is where the hosted web server on the ESP32 devices in Typescript is developed. See the [Web interface overview](/docs/software/web) for more details.
The [meshtastic/web](https://github.com/meshtastic/web) repository is where the hosted web server on the ESP32 devices in Typescript is developed. See the [Web interface overview](/docs/software/web-interface) for more details.
The [meshtastic/meshtastic.js](https://github.com/meshtastic/meshtastic.js) repository is a JavaScript library that provides an interface for Meshtastic devices.

View file

@ -44,7 +44,7 @@ The now-in-beta iOS app requires iOS v15.
### How do I get the Meshtastic iOS App?
See [iOS App](/docs/software/apple)
See [iOS App](/docs/category/apple-apps)
### After updating firmware, my node is not connecting via Bluetooth. What should I do?

View file

@ -1,6 +1,6 @@
position: 2 # float position is supported
label: 'Android'
collapsible: true # make the category collapsible
label: Android
collapsible: true
position: 2
link:
type: generated-index
title: Android

View file

@ -2,7 +2,7 @@
id: documentation
title: Maintaining Documentation
sidebar_label: Documentation
sidebar_position: 6
sidebar_position: 3
---
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.

View file

@ -1,6 +1,6 @@
position: 1 # float position is supported
label: Firmware
collapsible: true # make the category collapsible
collapsible: true
position: 1
link:
type: generated-index
title: Firmware

View file

@ -3,6 +3,7 @@ id: protobuf-api
title: Protobuf API Reference
slug: /protobufs/api
sidebar_label: Protobuf Reference
sidebar_position: 20
---
<!-- THIS PAGE IS AUTOGENERATED FROM ./scripts/gen-proto-docs.sh DO NOT EDIT -->

View file

@ -1,7 +1,8 @@
---
id: web-development-software
title: Information for developers of the web interface
sidebar_label: Development
sidebar_label: Web Interface
sidebar_position: 4
---
## Considerations

View file

@ -5,6 +5,6 @@ sidebar_label: Python Flasher
sidebar_position: 2
---
import MFlasher from '../../../software/python/flasher.mdx'
import MFlasher from '../../../software/python-flasher.mdx'
<MFlasher components={props.components} />

View file

@ -5,6 +5,6 @@ sidebar_label: Python Flasher
sidebar_position: 2
---
import MFlasher from '../../../software/python/flasher.mdx'
import MFlasher from '../../../software/python-flasher.mdx'
<MFlasher components={props.components} />

View file

@ -147,12 +147,12 @@ For RAK4631 users, if you have a RAK4631-R (the RUI3 bootloader version of the R
## Use Meshtastic
### with mobile apps
- [Android](/docs/software/android/)
- [Apple](/docs/software/apple/)
- [Android](/docs/category/android-app)
- [Apple](/docs/category/apple-apps)
### with a browser
- https://client.meshtastic.org
- [Meshtastic Web](/docs/software/web/)
- [Meshtastic Web](/docs/software/web-interface)
### over the internet with MQTT
- [MQTT](/docs/software/mqtt/)

View file

@ -0,0 +1,6 @@
label: Android App
collapsible: true
position: 1
link:
type: generated-index
title: Android App

View file

@ -1,7 +1,7 @@
---
id: android-installation
title: Android Application Installation
sidebar_label: Android App
sidebar_label: Installation
sidebar_position: 1
---

View file

@ -1,7 +1,8 @@
---
id: android-usage
title: Android application usage
title: Android Application Usage
sidebar_label: Usage
sidebar_position: 2
---
## Introduction

View file

@ -0,0 +1,6 @@
label: Apple Apps
collapsible: true
position: 2
link:
type: generated-index
title: Apple Applications

View file

@ -1,14 +0,0 @@
---
id: ios-development
title: Apple Applications
sidebar_label: Apple Apps
sidebar_position: 2
---
The Meshtastic Apple Apps are currently available in TestFlight as public betas with a projected App Store release November of 2022.
There are less than 1000 remaining beta spaces available and there are no codes.
iOS 16 is required and you can sign up by opening the following link on any iOS, iPadOS device with TestFlight installed.
https://testflight.apple.com/join/c8nNl8q1

View file

@ -0,0 +1,30 @@
---
id: installation
title: Apple Application Installation
sidebar_label: Installation
---
The Meshtastic Apple Apps are currently available in TestFlight as public betas with a projected App Store release November of 2022.
There are less than 1000 remaining beta spaces available and there are no codes.
iOS 16 is required and you can sign up by opening the following link on any iOS, iPadOS device with TestFlight installed.
https://testflight.apple.com/join/c8nNl8q1
## iOS and iPadOS
### TestFlight
A beta iOS and iPadOS application is available in the TestFlight app using the following link:
https://testflight.apple.com/join/c8nNl8q1
## macOS
### TestFlight
A beta macOS application will be available in the TestFlight app for macOS using the following link once macOS Ventura is released:
https://testflight.apple.com/join/c8nNl8q1

View file

@ -1,11 +0,0 @@
---
id: ios
title: iOS & iPadOS
sidebar_label: iOS & iPadOS
---
## iOS and iPadOS TestFlight
A beta iOS and iPadOS application is available in the TestFlight app using the following link:
https://testflight.apple.com/join/c8nNl8q1

View file

@ -1,12 +0,0 @@
---
id: macos
title: macOS
sidebar_label: macOS
---
## macOS TestFlight
A beta macOS application will be available in the TestFlight app for macOS using the following link once macOS Ventura is released:
https://testflight.apple.com/join/c8nNl8q1

View file

@ -1,9 +1,11 @@
---
id: offline-maps
title: Offline Maps
sidebar_label: Offline Maps
id: apple-apps-usage
title: Apple Application Usage
sidebar_label: Usage
---
## Offline Maps
The Meshtastic app for iOS, iPadOS and macOS supports the sharing of a .mbtiles file with the app for offline map support.
There is an open source cross platform mapping program call [QGIS](https://www.qgis.org/en/site/)

View file

@ -1,7 +0,0 @@
label: Golang
collapsible: true # make the category collapsible
position: 7
link:
type: generated-index
title: Golang
slug: /software/go

View file

@ -1,9 +0,0 @@
---
id: golang-cli
title: Meshtastic Go CLI
sidebar_label: CLI
---
:::info
This project is currently in progress
:::

View file

@ -1,9 +0,0 @@
---
id: golang-desktop
title: Meshtastic Desktop
sidebar_label: Desktop
---
:::info
This project is currently in progress
:::

View file

@ -1,9 +0,0 @@
---
id: golang-library
title: Meshtastic Go Library
sidebar_label: Go Library
---
:::info
This project is currently in progress
:::s

View file

@ -1,6 +1,7 @@
---
id: python-cli
title: Meshtastic Command Line Interface
slug: /software/python/cli
sidebar_label: Python CLI
---

View file

@ -1,7 +1,8 @@
---
id: installation
title: Meshtastic-python installation
title: Meshtastic Python CLI installation
sidebar_label: Installation
slug: /software/python/cli/installation
sidebar_position: 1
---
@ -14,7 +15,7 @@ The [Meshtastic-python repo](https://github.com/meshtastic/Meshtastic-python) an
If you wish to view the code or contribute to development of the python library or the command line interface, please visit the Meshtastic python [GitHub page](https://github.com/meshtastic/Meshtastic-python).
There are standalone executables for Mac, Windows and Ubuntu if you do not want to install python and/or the python libraries required to run the mestastic CLI tool. See [Standalone](/docs/software/python/python-standalone) for more information.
There are standalone executables for Mac, Windows and Ubuntu if you do not want to install python and/or the python libraries required to run the mestastic CLI tool. See [Standalone](#standalone) for more information.
Installation can also be easily done through the [Python package installer pip](https://pypi.org/project/meshtastic):
:::note
@ -202,3 +203,102 @@ Be aware that the Meshtastic CLI is not able to control the nodes over USB throu
:::info
You may need to close and re-open the CLI. The path variables may or may not update for the current session when installing.
:::
## Standalone
There are standalone executable files for Mac, Windows and Ubuntu. A single file is all you need to run the command line interface (CLI) Meshtastic tool. There is a zip file per operating system. To use, see the operating system specific notes below:
They can be found on the [Releases](https://github.com/meshtastic/Meshtastic-python/releases) page.
<Tabs
groupId="operating-system"
defaultValue="windows"
values={[
{label: 'Ubuntu', value: 'ubuntu'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
<TabItem value="ubuntu">
- Download meshtastic_ubuntu
- Run the following command to make the file executable and rename it 'meshtastic':
```
chmod +x meshtastic_ubuntu && mv meshtastic_ubuntu meshtastic
```
- To run the cli:
```
./meshtastic
```
:::tip
Copy (or move) this binary somewhere in your path.
:::
</TabItem>
<TabItem value="macos">
- Download meshtastic_mac
- Run the following command to make the file executable and to rename it 'meshtastic':
```
chmod +x meshtastic_mac && mv meshtastic_mac meshtastic
```
- Try to run it:
```
./meshtastic
```
:::note
You may get a dialog that says:
"meshtastic" can't be opened because Apple cannot check it for malicious software.
:::
- To fix, go into "System Preferences", "Security & Privacy", "General" tab, and click on the "Allow Anyway" button.
- Try to run it again:
```
./meshtastic
```
:::note
You may get a dialog that says:
"meshtastic" can't be opened because Apple cannot check it for malicious software.
Click "Open".
:::
- Now when you want to run it, you can simply run:
```
./meshtastic
```
:::tip
Copy (or move) this binary somewhere in your path.
:::
</TabItem>
<TabItem value="windows">
- Download meshtastic_windows
- Rename to meshtastic.exe
- To run, open a windows command prompt, navigate to the location of the executable and run:
```
meshtastic.exe
```
</TabItem>
</Tabs>

View file

@ -2,6 +2,7 @@
id: usage
title: Using the Meshtastic CLI
sidebar_label: Usage
slug: /software/python/cli/usage
sidebar_position: 2
---

View file

@ -1,8 +1,9 @@
---
id: flasher
title: Using Meshtastic Flasher
sidebar_label: Meshtastic Flasher
sidebar_position: 1
title: Using Meshtastic Python Flasher
sidebar_label: Python Flasher
slug: /software/python/flasher
sidebar_position: 3
---
import Tabs from '@theme/Tabs';

View file

@ -1,102 +0,0 @@
---
id: python-standalone
title: Meshtastic-python standalone executable
sidebar_label: Standalone
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
There are standalone executable files for Mac, Windows and Ubuntu. A single file is all you need to run the command line interface (CLI) Meshtastic tool. There is a zip file per operating system. To use, see the operating system specific notes below:
They can be found on the [Releases](https://github.com/meshtastic/Meshtastic-python/releases) page.
<Tabs
groupId="operating-system"
defaultValue="windows"
values={[
{label: 'Ubuntu', value: 'ubuntu'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
<TabItem value="ubuntu">
- Download meshtastic_ubuntu
- Run the following command to make the file executable and rename it 'meshtastic':
```
chmod +x meshtastic_ubuntu && mv meshtastic_ubuntu meshtastic
```
- To run the cli:
```
./meshtastic
```
:::tip
Copy (or move) this binary somewhere in your path.
:::
</TabItem>
<TabItem value="macos">
- Download meshtastic_mac
- Run the following command to make the file executable and to rename it 'meshtastic':
```
chmod +x meshtastic_mac && mv meshtastic_mac meshtastic
```
- Try to run it:
```
./meshtastic
```
:::note
You may get a dialog that says:
"meshtastic" can't be opened because Apple cannot check it for malicious software.
:::
- To fix, go into "System Preferences", "Security & Privacy", "General" tab, and click on the "Allow Anyway" button.
- Try to run it again:
```
./meshtastic
```
:::note
You may get a dialog that says:
"meshtastic" can't be opened because Apple cannot check it for malicious software.
Click "Open".
:::
- Now when you want to run it, you can simply run:
```
./meshtastic
```
:::tip
Copy (or move) this binary somewhere in your path.
:::
</TabItem>
<TabItem value="windows">
- Download meshtastic_windows
- Rename to meshtastic.exe
- To run, open a windows command prompt, navigate to the location of the executable and run:
```
meshtastic.exe
```
</TabItem>
</Tabs>

View file

@ -1,5 +1,5 @@
---
id: web-app-software
id: web-interface
title: Web interface overview
sidebar_label: Web Interface
sidebar_position: 8
@ -85,4 +85,4 @@ Option 3) Flash the device with the SPIFFS instructions in platform.io.
This issue is likely found on old versions of the web interface. Device firmware now includes the web interface and the file system has been changed. Flashing the device with [Meshtastic-flasher](/docs/software/python/flasher) will update you to the current web interface. Access to the files in the filesystem is actively being developed, but is not currently available.
:::
Cause: Typically a small partition has been set aside from previous firmware installed on the module. Instructions for how to fix this can be found on the [ESP32-Partitions](/docs/software/web/web-partitions-software) page.
Cause: Typically a small partition has been set aside from previous firmware installed on the module. Instructions for how to fix this can be found on the [ESP32-Partitions](/docs/development/web/web-partitions-software) page.

View file

@ -58,6 +58,10 @@ const config = {
label: 'Contributing',
to: 'docs/contributing',
},
{
label: 'Legal',
to: 'docs/legal',
},
{
label: 'FAQs',
to: 'docs/faq',

View file

@ -3,6 +3,7 @@ id: protobuf-api
title: Protobuf API Reference
slug: /protobufs/api
sidebar_label: Protobuf Reference
sidebar_position: 20
---
<!-- THIS PAGE IS AUTOGENERATED FROM ./scripts/gen-proto-docs.sh DO NOT EDIT -->