Add a cookbook landing page indexing all examples and recipes#1770
Draft
maziyarpanahi wants to merge 1 commit into
Draft
Add a cookbook landing page indexing all examples and recipes#1770maziyarpanahi wants to merge 1 commit into
maziyarpanahi wants to merge 1 commit into
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.
Description
Adds a task-oriented Cookbook landing page that maps common OpenMed goals to the exact existing scripts, notebooks, and copy-ready recipes that implement them. This makes the repository's current examples discoverable without replacing the longer examples guide.
Type of Change
Changes Made
Testing
Validation completed:
.venv/bin/python -m pytest tests/ -q— 5,201 passed, 46 skipped.venv/bin/python -m mkdocs build --strictpre-commit run --files docs/cookbook.md docs/examples.md mkdocs.yml tests/unit/test_docs_cookbook_links.pyDocumentation
No public Python API or release metadata changed.
Code Quality
make format,make lint, andmake format-checkmake format-swiftandmake lint-swiftDependencies
Checklist
Related Issues
Closes #478
Screenshots/Examples
Not applicable; this change adds documentation and validation coverage.