diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7384e1bf..4dca97a9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -106,3 +106,8 @@ the documentation. ## Updating Dependencies If you make changes to the `requirements` text files, please also update the `additional_dependencies` list under the `mypy` hook in `.pre-commit-config.yaml`. This is necessary for accurate type-checking. + +## Contributing Documentation Changes and Fixes +When making adjustments or contributions to documentation, please use the `dev-gh-pages` branch. This is where all the documentation lives. +After you've completed your edits, open a Github Pull Request (PR) to merge into `dev-gh-pages` from your fork. During a version release, `dev-gh-pages` is merged +into the `gh-pages` branch (after `update_documentation.py` is run) and is the version associated with the documentation website and stable version.