AREDN Documentation Repository
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
Steve 54cff69586
update mesh status with rf (#340)
2 weeks ago
_images add supernode info to Network Design Guide (#290) 5 months ago
appendix update Known Issues list 10 months ago
arednGettingStarted update mesh status with rf (#340) 2 weeks ago
arednHow-toGuides add vm installs How-To (#337) 2 weeks ago
arednNetworkDesign add supernode info to Network Design Guide (#290) 5 months ago
arednServicesGuide update wording for AAMM (#323) 2 months ago
.gitignore Add Sphinx Makefile to repo (#104) 3 years ago
.readthedocs.yaml add offline build formats (#325) 2 months ago
How to Use GitHub for AREDN.md Update HowTo MD file with new default branch name (#100) 3 years ago
Makefile Add Sphinx Makefile to repo (#104) 3 years ago
README.md fix links/referrers to external sites (#220) 1 year ago
conf.py set to latest (#319) 3 months ago
index.rst add vm installs How-To (#337) 2 weeks ago
requirements.txt sphinx version (#261) 10 months ago

README.md

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 https://arednmesh.readthedocs.io/en/latest/ or select your choice from the Docs dropdown menu on https://www.arednmesh.org.

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.

Contributing:

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 ReadTheDocs.org. 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.