Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add contributor notes on where to find documentation branches #1113

Merged
merged 5 commits into from
Apr 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.