diff --git a/README.md b/README.md index 935aa6f..3ffd6dc 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ To view the AREDN documentation in a web browser, navigate to [https://arednmesh 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 identical to the workflow for contributing code which 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). +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 identical to the workflow for contributing code which 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). -The only difference is the repository name of `aredn/documentation` and the main branch name of `master`. Your local code branch name can be anything that makes sense to you. 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 +The only difference is the repository name of `aredn/documentation` and the main branch name of `master`. 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 updates and builds the latest docs for viewing and exporting on ReadTheDocs.org AREDN documentation is written using the reStructuredText markup language. Text is saved in "rst" files. Before committing your changes, be sure to test your `rst` files to ensure they will render correctly.