Repository navigation
Host the algorithm catalogue and documentation site in meds-algorithm - #14
Merged
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
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.
Move ownership of the algorithm catalogue from template PR #47 into meds-algorithm, the shared ecosystem repository. Add a small MkDocs site, the curated GenHPF entry, offline schema/rendering checks, and a weekly public-release observation workflow. The template retains only navigation and registration guidance.
Catalogue updates are independent of runtime releases: registry data, renderer, documentation tests and site configuration are excluded from both the wheel and source distribution. Runtime dependencies and version remain unchanged. Documentation tests live under docs/tests so the standalone installed-wheel runtime suite does not require repository documentation files.
Validation: 24 catalogue tests, 151 runtime tests against the installed wheel, Ruff, strict MkDocs, Twine and base-wheel smoke checks pass. Inspected both archives to verify catalogue exclusions. Template counterpart remains at 90 passing tests with a strict docs build.
Deployment setup: this repository currently has no GitHub Pages site. The authenticated account has push but not admin permissions; creating Pages returned 404. A repository admin must set Settings → Pages → Source to GitHub Actions before merging/deploying. Automated update PRs also require Actions permission to create PRs (permission settings could not be inspected: 403). No PyPI release is required.
Coordinate with McDermottHealthAI/MEDS_algorithm_template#47; that PR is being reduced to links and registration instructions. Broader documentation migration is intentionally separate.