AREDN Documentation Repository
Go to file
Tim Wilkinson c65296262a
Add note about possible wifi disconnect (#347)
* Add note about possible wifi disconnect

* Fix attention box
2024-04-10 16:20:46 -07:00
_images add supernode info to Network Design Guide (#290) 2023-09-21 15:10:15 -07:00
appendix update Known Issues list 2023-04-19 07:20:41 -07:00
arednGettingStarted Add note about possible wifi disconnect (#347) 2024-04-10 16:20:46 -07:00
arednHow-toGuides update xlink diag (#345) 2024-03-07 09:13:23 -07:00
arednNetworkDesign add supernode info to Network Design Guide (#290) 2023-09-21 15:10:15 -07:00
arednServicesGuide update meshchat release repo links (#342) 2024-03-04 20:07:33 -07:00
.gitignore Add Sphinx Makefile to repo (#104) 2021-03-15 09:55:41 -05:00
.readthedocs.yaml add offline build formats (#325) 2023-12-11 15:51:28 -07:00
How to Use GitHub for Update HowTo MD file with new default branch name (#100) 2021-01-29 13:56:46 -06:00
Makefile Add Sphinx Makefile to repo (#104) 2021-03-15 09:55:41 -05:00 fix links/referrers to external sites (#220) 2022-11-18 09:39:07 -06:00 set to latest (#319) 2023-12-05 10:52:17 -07:00
index.rst add vm installs How-To (#337) 2024-02-06 10:48:27 -07:00
requirements.txt sphinx version (#261) 2023-05-08 16:41:26 -05:00

AREDN Documentation

This repository is for creating documentation for the AREDN project so it can be made available on ReadTheDocs.

Viewing the Docs:

To view the AREDN documentation in a web browser, navigate to or select your choice from the Docs dropdown menu on

Exporting to PDF:

While viewing the AREDN documentation in your web browser, you will see the contents list in the left panel. At the bottom of the panel is a drawer labeled "ReadTheDocs" showing the version you are viewing. Click the label bar to open it. From the drawer you can export the documentation set as a single PDF or Epub file. This is handy if you want to take a PDF copy of the guidebook with you into the field where you do not have Internet access.


If you are interested in contributing to the rapidly growing set of AREDN related information, you can easily do so on GitHub. The workflow for contributing documentation is described in detail here: How to Use GitHub for AREDN.

AREDN documentation is written using the reStructuredText markup language and your text is saved in "rst" files. Before committing your changes, be sure to test your "rst" files locally using Sphinx to ensure they will render correctly.

Your local code branch name can be anything that makes sense to you. After you create your Pull Request, the AREDN team will review your request just as it does for code changes. Once your documentation contributions are committed to the AREDN GitHub repository, a webhook automatically updates and builds the latest docs for viewing and exporting on All contributions that are included by the AREDN® team in the documentation set will be covered by the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International license held by Amateur Radio Emergency Data Network, Inc.