mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-19 23:57:31 -07:00
Docs updates for ben
This commit is contained in:
Garth Vander Houwen
parent
0d954f2a3a
commit
085325ab05
7
docs/software/_category_.yml
Normal file
7
docs/software/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
position: 4 # float position is supported
|
||||
label: Software
|
||||
collapsible: true # make the category collapsible
|
||||
link:
|
||||
type: generated-index
|
||||
title: Software
|
||||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
id: android-installation
|
||||
title: Android application installation
|
||||
sidebar_label: Android app
|
||||
sidebar_label: Android App
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
Our Android application is available to download on Google Play Store. This allows you to connect to your Meshtastic® device from your Android phone.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
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 in the fall of 2022 alongside iOS 16.
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: community-overview
|
||||
title: Community applications
|
||||
sidebar_label: Community apps
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
The Meshtastic ecosystem is highly extensible, and a number of community projects have been made to fit different people's needs. If you wish to create your own application or module, please read the information in the developers section, and tell us about your project on the forum.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: device-firmware
|
||||
title: Device firmware
|
||||
sidebar_label: Device firmware
|
||||
sidebar_position: 1
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
The device firmware runs on the nodes to build the mesh for communication. Each different make and model of device requires a different build of the Meshtastic firmware in order to run properly. Thankfully, due to the design of Meshtastic, it is possible to port the firmware to new devices as they become available. The firmware currently runs on a range of ESP32 based devices, but there is also increasing support for the nRF52 microprocessor with some more recent devices coming to market.
|
||||
|
|
|
|||
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
title: Software
|
||||
sidebar_label: Software
|
||||
slug: /software
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
The following applications are available to support your Meshtastic network:
|
||||
|
||||
- The [firmware](/docs/software/device) to run on the devices
|
||||
- Connect to the devices with our [Android app](/docs/software/android)
|
||||
- An [iOS application](/docs/software/apple) is in the works
|
||||
- [Meshtastic.js](/docs/software/js/getting-started) provides a JavaScript library to interface with devices
|
||||
- [Meshtastic-python](/docs/software/python/python-installation) provides access from desktop computers including a command line interface
|
||||
- A [web interface](/docs/software/web) can be accessed over Wifi on ESP32 devices
|
||||
- Pre-installed device modules for:
|
||||
- [Range testing](/docs/software/modules/range-test-module)
|
||||
- [External notifications](/docs/software/modules/ext-notif-module)
|
||||
- [Canned messages](/docs/software/modules/canned-message-module)
|
||||
- [Serial communication](/docs/software/modules/serial-module)
|
||||
- [Store and forwarding messages](/docs/software/modules/store-forward-module) (in development)
|
||||
- [Telemetry](/docs/software/modules/telemetry-module) (in development)
|
||||
- Community projects include:
|
||||
- A [module](/docs/software/community/community-atak) for the [Android Team Awareness Kit (ATAK)](https://play.google.com/store/apps/details?id=com.atakmap.app.civ)
|
||||
- [PyGUI](/docs/software/community/community-pygui), a platform agnostic graphical user interface for devices
|
||||
|
||||
The devices running Meshtastic have many preferences that can be set, see the [Settings](/docs/settings) pages for more details.
|
||||
7
docs/software/js/_category_.yml
Normal file
7
docs/software/js/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
position: 7 # float position is supported
|
||||
label: 'Javascript'
|
||||
collapsible: true # make the category collapsible
|
||||
link:
|
||||
type: generated-index
|
||||
title: Javascript
|
||||
7
docs/software/modules/_category_.yml
Normal file
7
docs/software/modules/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
position: 5 # float position is supported
|
||||
label: Firmware Modules
|
||||
collapsible: true # make the category collapsible
|
||||
link:
|
||||
type: generated-index
|
||||
title: Firmware Modules
|
||||
7
docs/software/other/_category_.yml
Normal file
7
docs/software/other/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
position: 9 # float position is supported
|
||||
label: Other
|
||||
collapsible: true # make the category collapsible
|
||||
link:
|
||||
type: generated-index
|
||||
title: Other
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: remote-hardware-service
|
||||
title: Remote Hardware Service
|
||||
sidebar_label: Remote Hardware
|
||||
sidebar_label: 1.2 Remote Hardware
|
||||
---
|
||||
|
||||
FIXME - the following are a collection of notes moved from elsewhere. We need to refactor these notes into actual documentation on the remote-hardware/GPIO service.
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
id: sw-design
|
||||
title: Software Design
|
||||
sidebar_label: Software Design
|
||||
---
|
||||
|
||||
This is a mini design doc for developing the meshtastic software.
|
||||
|
||||
- [Build instructions](/docs/developers/firmware/build)
|
||||
- [On device module API](/docs/developers/firmware/module-api) - a tutorial on how to write small modules which run on the device and can message other nodes.
|
||||
- Our [project board](https://github.com/orgs/meshtastic/projects/1) - shows what things we are currently working on and remaining work items for the current release.
|
||||
- [Power Management](power)
|
||||
- [Mesh algorithm](/docs/developers/firmware/mesh-alg)
|
||||
- [External client API](/docs/developers/firmware/device-api) and porting guide for new clients (iOS, python, etc...)
|
||||
- TODO: how to port the device code to a new device.
|
||||
7
docs/software/python/_category_.yml
Normal file
7
docs/software/python/_category_.yml
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
position: 4 # float position is supported
|
||||
label: Python CLI
|
||||
collapsible: true # make the category collapsible
|
||||
link:
|
||||
type: generated-index
|
||||
title: Python
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
id: web-app-software
|
||||
title: Web interface overview
|
||||
sidebar_label: Web Interface
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
<!--- FIXME add self hosting details link --->
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ const config = {
|
|||
},
|
||||
{
|
||||
label: 'Software',
|
||||
to: 'docs/software',
|
||||
to: 'docs/category/software',
|
||||
},
|
||||
{
|
||||
label: 'Developers',
|
||||
|
|
|
|||
Loading…
Reference in a new issue