more tutorial and doc updates #529
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jhnwu3
added
Highlight
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances the PyHealth documentation by adding a comprehensive contribution guide, updating tutorial links for PyHealth 2.0 compatibility, and improving documentation navigation.
- Added a detailed "How to Contribute" guide with development setup, coding standards, and contribution guidelines
- Updated tutorial links to reflect PyHealth 2.0 compatibility and added version labels for older videos
- Fixed navigation issues and improved discoverability of the contribution guide
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/how_to_contribute.rst | New comprehensive contribution guide covering setup, coding standards, and PR requirements |
| docs/tutorials.rst | Updated tutorial links for PyHealth 2.0 and fixed documentation typo |
| docs/index.rst | Added contribution guide to navigation and commented out advance_tutorials |
docs/tutorials.rst
Outdated
| ======================== | ||
|
|
||
| We provide the following tutorials to help users get started with our pyhealth. Please bare with us as we update the docuemntation on how to use pyhealth. | ||
| We provide the following tutorials to help users get started with our pyhealth. Please bare with us as we update the documentation on how to use pyhealth 2.0. |
There was a problem hiding this comment.
The word 'bare' should be 'bear'. The correct phrase is 'Please bear with us' (meaning 'please be patient with us').
Suggested change
| We provide the following tutorials to help users get started with our pyhealth. Please bare with us as we update the documentation on how to use pyhealth 2.0. | |
| We provide the following tutorials to help users get started with our pyhealth. Please bear with us as we update the documentation on how to use pyhealth 2.0. |
dalloliogm
pushed a commit
to dalloliogm/PyHealth
that referenced
this pull request
Nov 26, 2025
* more tutorial and doc updates * fix grammar --------- bypassing protections because it's a .rst docs update. Co-authored-by: John Wu <johnwu3@sunlab-work-01.cs.illinois.edu>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request focuses on enhancing the documentation for the PyHealth project. It introduces a comprehensive contribution guide, updates tutorial links for PyHealth 2.0, and improves navigation within the documentation. These changes aim to streamline the contribution process and provide clearer guidance for users and contributors.
Documentation Enhancements:
Contribution Guide:
docs/how_to_contribute.rst. This includes guidelines for setting up the development environment, coding standards, types of contributions (datasets, tasks, models), test case requirements, and pull request formatting.Tutorials:
docs/tutorials.rstto reflect compatibility with PyHealth 2.0 and provided updated links to Colab notebooks and videos.Navigation Improvements:
docs/index.rstfor better discoverability.docs/index.rstwhere "advance_tutorials" was incorrectly displayed.