Merged
Conversation
dalloliogm
pushed a commit
to dalloliogm/PyHealth
that referenced
this pull request
Nov 26, 2025
* more navigation doc updates for users * fixes for some of the docs - doc updates
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
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 significantly enhances the PyHealth documentation by adding comprehensive "Getting Started" sections, detailed contribution checklists, and best practices for writing fast, reproducible tests. These changes make it much easier for new users and contributors to understand how to use PyHealth's features, access data, and contribute effectively. The documentation now includes step-by-step guides, example workflows, and explicit instructions for using synthetic data in tests, improving both usability and maintainability.
Documentation improvements for onboarding and usage:
data,datasets,tasks,calib, andinterpret, each with links to tutorials, videos, and example workflows illustrating core concepts and usage patterns. [1] [2] [3] [4] [5]Contributor guidelines and best practices:
Testing and CI/CD improvements:
These updates collectively improve the onboarding experience for new users, clarify contribution requirements, and ensure the codebase remains robust and maintainable.