Skip to content

Commit

Permalink
docs: add contributor notes on where to find documentation branches (#…
Browse files Browse the repository at this point in the history
…1113)

* docs: add contributor notes on where to find documentation branches

* docs: update documentation wording to spell out why `dev-gh-pages` and `gh-pages` branches exist for staging content

* docs: add note on fork

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>

* Update .github/CONTRIBUTING.md

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>

---------

Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
  • Loading branch information
carlsonp and taylorfturner authored Apr 8, 2024
1 parent cd71573 commit eb45208
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit eb45208

Please sign in to comment.