ARDEN-documentation/README.md

16 lines
2.2 KiB
Markdown
Raw Normal View History

2024-08-05 09:09:14 -06:00
# AREDN® Documentation
This repository is for creating documentation for the AREDN® project so it can be made available on ReadTheDocs.
## Viewing the Docs:
2024-08-05 09:09:14 -06:00
To view the AREDN® documentation in a web browser, navigate to [https://arednmesh.readthedocs.io/en/latest/](https://arednmesh.readthedocs.io/en/latest/) or select your choice from the `Docs` dropdown menu on [https://www.arednmesh.org](https://www.arednmesh.org).
## Exporting to PDF:
2024-08-05 09:09:14 -06:00
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:
2024-08-05 09:09:14 -06:00
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](https://github.com/aredn/documentation/blob/master/How%20to%20Use%20GitHub%20for%20AREDN.md).
2024-08-05 09:09:14 -06:00
AREDN® documentation is written using the [reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html) markup language and your text is saved in "rst" files. Before committing your changes, be sure to test your "rst" files locally using [Sphinx](https://www.sphinx-doc.org/en/master/usage/quickstart.html) to ensure they will render correctly.
2024-08-05 09:09:14 -06:00
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.