Merge pull request #364 from meshtastic/nav_casing_updates

Nav casing updates
This commit is contained in:
Ben Meadors 2022-06-30 14:08:42 -05:00 committed by GitHub
commit 6bad45bcd5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 80 additions and 71 deletions

View file

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

View file

@ -10,7 +10,7 @@ The routing protocol for Meshtastic is really quite simple (and suboptimal). If
### A Note About Protocol Buffers ### A Note About Protocol Buffers
Because we want our devices to work across various vendors and implementations, we use [Protocol Buffers](https://github.com/meshtastic/Meshtastic-protobufs) pervasively. For information on how the protocol buffers are used with respect to API clients see [sw-design](/docs/software/other/sw-design), for purposes of this document you mostly only Because we want our devices to work across various vendors and implementations, we use [Protocol Buffers](https://github.com/meshtastic/Meshtastic-protobufs) pervasively. For purposes of this document you mostly only
need to consider the MeshPacket and Subpacket message types. need to consider the MeshPacket and Subpacket message types.
### Layer 0: LoRa Radio ### Layer 0: LoRa Radio

View file

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

View file

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

View file

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

@ -0,0 +1,7 @@
position: 1 # float position is supported
label: 'Style Guides'
collapsible: true # make the category collapsible
link:
type: generated-index
title: Style Guides

View file

@ -34,4 +34,4 @@ After reading this FAQ and checking out the links on the left, there are two pla
### How can I contribute to Meshtastic? ### How can I contribute to Meshtastic?
Everyone contributes in a different way. Join the [Forum](https://meshtastic.discourse.group) and/or the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Developers](/docs/developers) menu on the left. Everyone contributes in a different way. Join the [Forum](https://meshtastic.discourse.group) and/or the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Developers](/docs/category/developers) menu on the left.

View 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

View file

@ -1,7 +1,8 @@
--- ---
id: android-installation id: android-installation
title: Android application 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. Our Android application is available to download on Google Play Store. This allows you to connect to your Meshtastic® device from your Android phone.

View file

@ -2,6 +2,7 @@
id: ios-development id: ios-development
title: Apple Applications title: Apple Applications
sidebar_label: Apple Apps 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. 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.

View file

@ -2,6 +2,7 @@
id: community-overview id: community-overview
title: Community applications title: Community applications
sidebar_label: Community apps 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. 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.

View file

@ -2,7 +2,7 @@
id: device-firmware id: device-firmware
title: Device firmware title: Device firmware
sidebar_label: 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. 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.

View file

@ -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.

View 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

View 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

View 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

View file

@ -1,7 +1,7 @@
--- ---
id: power id: power
title: Power Management State Machine title: 1.2 Power Management State Machine
sidebar_label: Power Management sidebar_label: 1.2 Power Management
--- ---
i.e. sleep behavior i.e. sleep behavior

View file

@ -1,7 +1,7 @@
--- ---
id: remote-hardware-service id: remote-hardware-service
title: 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. 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.

View file

@ -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.

View 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

View file

@ -2,6 +2,7 @@
id: web-app-software id: web-app-software
title: Web interface overview title: Web interface overview
sidebar_label: Web Interface sidebar_label: Web Interface
sidebar_position: 3
--- ---
<!--- FIXME add self hosting details link ---> <!--- FIXME add self hosting details link --->

View file

@ -88,11 +88,11 @@ const config = {
}, },
{ {
label: 'Software', label: 'Software',
to: 'docs/software', to: 'docs/category/software',
}, },
{ {
label: 'Developers', label: 'Developers',
to: 'docs/developers', to: 'docs/category/developers',
}, },
], ],
}, },

View file

@ -6,24 +6,7 @@ module.exports = {
{ {
type: 'autogenerated', type: 'autogenerated',
dirName: '.', dirName: '.',
},
],
developers: [
{
type: 'category',
label: 'Developers',
link: {
type: 'generated-index',
title: 'Developer Documentation',
description: 'Meshtastic developer resources',
slug: '/developers',
},
items: [
{
type: 'autogenerated',
dirName: 'developers',
},
],
}, },
], ],
}; };