Skip to content

Commit

Permalink
Update index.rst (#3)
Browse files Browse the repository at this point in the history
* Update index.rst
* Update index.rst
* Update README.md
  • Loading branch information
Steve Lewis KC0EUW authored and ae6xe committed Dec 24, 2018
1 parent ef7671a commit 49a2a16
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# 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://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. This works the same way as if you were contributing code to the project.

Expand All @@ -14,8 +20,3 @@ After you setup your GitHub account, you should:

The AREDN team will then review your request just as it does for code changes. Once your documentation contributions are committed to the AREDN GitHub repository, a webhook updates and builds the latest docs for viewing and exporting on ReadTheDocs.org

## Viewing the Docs:
To view the AREDN documentation in a web browser, navigate to ReadTheDocs.org and search for the AREDN Documentation.

## Exporting to PDF:
While viewing the AREDN documentation in your web browser, you will see the Topics 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.
15 changes: 12 additions & 3 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ AREDN Documentation
===================

:Version: 3.18.9.0
:Reviewers: KC0EUW, K5DLQ, AE6XE, K6AH, WU2S

**Contents:**
This documentation set contains the *Getting Started Guide* which walks through the process of configuring an AREDN |trade| radio node. It also contains the *Network Design Guide* which provides background information and tips for planning and deploying a robust mesh network.

.. toctree::
:maxdepth: 2
:caption: Getting Started Guide
:hidden:

arednGettingStarted/aredn_overview
arednGettingStarted/selecting_devices
Expand All @@ -22,13 +24,20 @@ AREDN Documentation
.. toctree::
:maxdepth: 2
:caption: Network Design Guide
:hidden:

arednNetworkDesign/networking_overview
arednNetworkDesign/network_topology
arednNetworkDesign/frequency_bands
arednNetworkDesign/channel_planning
arednNetworkDesign/network_modeling
more_info

.. toctree::
:maxdepth: 1
:hidden:

:Reviewers: KC0EUW, K5DLQ, AE6XE, K6AH, WU2S
more_info


.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
:ltrim:

0 comments on commit 49a2a16

Please sign in to comment.