Updating the documentation¶
To update the documentation, follow these steps:
- Make sure you have the latest version of the documentation repository.
- Fork the repository on GitHub.
- Create a new branch for your changes.
- Make your changes to the documentation files, either on GitHub or locally after cloning the forked repository (recommended). If you create a new page in guides, add the name of the new page to
guides/index.mdand tomkdocs.yml(sectionnav). - Test your changes locally to ensure they work as expected:
- install the python package mkdocs with
pip install mkdocs - in the python console, move to the local repository of the documentation and run
mkdocs serve - copy-paste the http link from the console to a web browser to visualize the website
- keep mkdocs running while making changes to the documentation (changes are automatically made to the website preview on the browser).
- install the python package mkdocs with
- Commit your changes and push the branch to the remote repository.
- Create a pull request to merge your changes into the main branch of the documentation repository.
- Before making any additional change locally, make sure to (1) synchronize the forked repository with the original one and (2) pull the remote branch to the local repository.