Skip to content

Commit

Permalink
Minor text update
Browse files Browse the repository at this point in the history
  • Loading branch information
kabilar committed Nov 21, 2024
1 parent 453a91b commit 8dc09c9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/contribute.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Contribute to this documentation

If you find an issue with this documentation please file an issue or submit a pull request on the [linc-convert repository](https://github.com/lincbrain/linc-convert).
If you find an issue with this documentation please file an issue or submit a pull request on the [linc-convert](https://github.com/lincbrain/linc-convert) 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:

1. Fork the [linc-convert repository](https://github.com/lincbrain/linc-convert) and clone it to your computer.
2. Set up a Python environment with the dependencies in the [requirements.txt file](https://github.com/lincbrain/linc-convert/blob/main/requirements.txt).
1. Fork the [linc-convert](https://github.com/lincbrain/linc-convert) repository and clone it to your computer.
2. Set up a Python environment with the dependencies in the [requirements.txt](https://github.com/lincbrain/linc-convert/blob/main/requirements.txt) file.
3. 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.
4. As you continue to edit the markdown files or configuration file, your documentation will be automatically re-built and rendered locally.
5. Commit your changes and submit a pull request.

0 comments on commit 8dc09c9

Please sign in to comment.