docs: add missing example categories to examples catalogue (#645)#672
Merged
planetf1 merged 2 commits intogenerative-computing:mainfrom Mar 17, 2026
Merged
Conversation
…e-computing#645) Add plugins, m_decompose, tutorial, notebooks, and hello_world to the examples index page so all runnable example directories are discoverable from the published docs. Also add a note to CONTRIBUTING.md reminding authors to update the catalogue when adding new example directories.
Contributor
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Add validate_examples_catalogue() to validate.py that checks every example directory under docs/examples/ (containing .py files) has a corresponding entry in docs/docs/examples/index.md. Also refine the CONTRIBUTING.md guideline to frame it as a check rather than only an instruction for when adding examples.
jakelorocco
approved these changes
Mar 17, 2026
Merged
via the queue into
generative-computing:main
with commit Mar 17, 2026
a86fe40
7 of 8 checks passed
8 tasks
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
2 participants
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.
Misc PR
Type of PR
Description
Partially Fixes docs: pre-release documentation verification pass #645
Complete the examples catalogue and add automated validation to prevent
future drift.
docs/docs/examples/index.md:plugins/,m_decompose/,tutorial/,notebooks/, andhello_world.py— these directories existed indocs/examples/butwere not discoverable from the published docs
validate_examples_catalogue()check totooling/docs-autogen/validate.pythat fails the doc validation if any example directory (containing
.pyfiles) is missing from the catalogue
skip empty dirs)
CONTRIBUTING.mdto remind authors to check all examples arecatalogued, not just newly added ones
Also raised #671 for a follow-up: add a highlighted IVR walkthrough page
to match the other four featured examples.
Testing