Contribute to this documentation¶
If you find an issue with this documentation please file an issue or submit a pull request on the linc-docs repository.
If you would like to contribute to the LINC documentation and render the documentation locally as you make edits, please follow the steps below:
- Fork the linc-docs repository and clone it to your computer.
- Set up a Python environment with the dependencies in the requirements.txt file.
- Within the Python environment, run
mkdocs serve
. This will build the website and start a local webserver (e.g. at http://127.0.0.1:8000) with your documentation. - As you continue to edit the markdown files or configuration file, your documentation will be automatically re-built and rendered locally.
- Commit your changes and submit a pull request.