ARDEN-documentation/index.rst

68 lines
2.5 KiB
ReStructuredText

===================
AREDN Documentation
===================
:Version: 3.18.9.0 plus nightly build additions
:Reviewers: KC0EUW, K5DLQ, AE6XE, K6AH, WU2S
This documentation set consists of several sections which are shown in the navigation list.
* The **Getting Started Guide** walks through the process of configuring an AREDN |trade| radio node to be part of a mesh network.
* The **Network Design Guide** provides background information and tips for planning and deploying a robust mesh network.
* The **Applications and Services Guide** discusses the types of programs or services that can be used across a mesh network. *NOTE: This section is incomplete while in progress.*
* Finally, the **Appendix** contains supplementary information.
If you wish to locate specific topics within the documentation, you can type keywords into the *Search docs* field to display a list of items which match your search.
If you would like to see the documentation for a specific AREDN release, click on the **Read the Docs** label at the bottom of the navigation bar. This label shows the version you are currently viewing, but clicking the label bar opens a panel with several other options. Here you may choose to view another version of the documentation, and you can also download the entire documentation set in any of several formats *(PDF, ePub, HTML)* for offline use.
.. toctree::
:maxdepth: 1
:caption: Getting Started Guide
:hidden:
arednGettingStarted/aredn_overview
arednGettingStarted/selecting_devices
arednGettingStarted/downloading_firmware
arednGettingStarted/installing_firmware
arednGettingStarted/basic_setup
arednGettingStarted/node_status
arednGettingStarted/mesh_status
arednGettingStarted/advanced_config
.. toctree::
:maxdepth: 1
:caption: Network Design Guide
:hidden:
arednNetworkDesign/networking_overview
arednNetworkDesign/network_topology
arednNetworkDesign/frequency_bands
arednNetworkDesign/channel_planning
arednNetworkDesign/network_modeling
.. toctree::
:maxdepth: 1
:caption: Applications and Services Guide
:hidden:
arednServicesGuide/services_overview
arednServicesGuide/chat_programs
arednServicesGuide/email_programs
arednServicesGuide/file_sharing
arednServicesGuide/voip_programs
arednServicesGuide/video_streaming
arednServicesGuide/collaborative_editing
arednServicesGuide/other_programs
.. toctree::
:maxdepth: 1
:caption: Appendix
:hidden:
more_info
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
:ltrim: