Skip to content

Consolidate template documentation and prompt builder on Read the Docs - #17

Merged
florian6973 merged 2 commits into
mainfrom
codex/unified-documentation
Nov 8, 2026
Merged

florian6973 merged 2 commits into
mainfrom
codex/unified-documentation

Conversation

@florian6973

@florian6973 florian6973 commented Nov 8, 2026 •

Copy link
Copy Markdown
Collaborator

Consolidate all template site documentation in the meds-algorithm Read the Docs site: concepts, profiles, workflow, prompt builder, manual example, running, publishing, migration, API/UML and test inventories. Keep the algorithm catalogue in place. Companion: McDermottHealthAI/MEDS_algorithm_template#49

The static implementation prompt is the single source embedded by the interactive builder. Core references render from this checkout. Four template-owned release/test guides are fetched from immutable revision 3cf2969d7c15a78e4bf43994ed2121e0aea8ba65, SHA-256 verified and cached, avoiding maintained copies. A clean build needs network access for these public files.

Read the Docs is the sole documentation host. Remove all Pages deployment steps, redirect files, scripts, tests and references. GitHub Actions retains documentation validation only. Both repositories now have Pages disabled and their unused github-pages environments removed.

Validation: 36 documentation/catalogue tests, 9 browser tests, lint/format, strict MkDocs build with uncached template-source fetch, wheel/sdist builds and Twine checks pass. The companion template previously passed its full 87-test suite and installed-generator smoke checks; this follow-up only removes hosting files and updates documentation.

Merge/deploy this PR first, then merge template PR #49. No runtime API or version changes.

@florian6973
florian6973 merged commit 1bc12f0 into main Nov 8, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant