Skip to content

Generate searchable example pages from READMEs - #148

Open
pastorsj wants to merge 6 commits into
NVIDIA:mainfrom
pastorsj:feat/catalog-search-industry-views
Open

Generate searchable example pages from READMEs#148
pastorsj wants to merge 6 commits into
NVIDIA:mainfrom
pastorsj:feat/catalog-search-industry-views

Conversation

@pastorsj

@pastorsj pastorsj commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Related Issue

No linked issue.

Description

  • Make each example's root README the single source for its title, description, industry, requirements, and conditional catalog fields; generate the catalog, search index, and detail pages automatically.
  • Add searchable category and industry views, URL-backed filters, responsive cards, and themed README pages with sanitized images and locally served Mermaid diagrams.
  • Add strict README metadata checks, catalog tests, pull-request preview artifacts, main-only GitHub Pages deployment, and contributor documentation for the new format.

Screenshots

Main Page

MainPage

Explore by Type/Collection/Industry

Explore (Type, Collection Explore (Industry)

Filter by Industry/Text Search

Filter (Text) Filter (Industry)

Preview of Recipe

PreviewOfRecipe

Verification

  • python3 scripts/check_license_headers.py --check
  • python3 scripts/check_label_taxonomy.py --check
  • git diff --check
  • Validated README metadata for all 18 discovered examples.
  • Validated generated catalog sources and local resources.
  • Passed 23 Python catalog tests and 11 JavaScript interaction tests.
  • Passed browser acceptance across the catalog and all generated detail pages.
  • Rendered and verified 15 Mermaid diagrams across 6 detail pages.
  • Passed the Agentic AI Learning Path validator.

Documentation Writer Review

  • Documentation writer review completed for the final changes
  • Result: docs-updated
  • Evidence or justification: Updated README.md, CONTRIBUTING.md, the example taxonomy, catalog architecture and deployment documentation, generated examples/README.md, all example README catalog blocks, site copy, and THIRD-PARTY-NOTICES.
  • Reviewer: Codex documentation-writer review
  • Changed user-facing text follows the writing guide and controlled-word list.
  • A public contributor can understand the changed text without internal company context.
  • I reviewed any agent-generated text before submission.

Release And Compliance

  • No secrets or credentials are included.
  • No nonpublic project names, environments, URLs, identifiers, logs, paths, screenshots, or configuration values are included.
  • Third-party dependency changes are reflected in THIRD-PARTY-NOTICES.
  • Public content uses sanitized examples and placeholders.
  • I added my DCO sign-off declaration to this pull request description.

Signed-off-by: Sam Pastoriza spastoriza@nvidia.com

Signed-off-by: Sam Pastoriza <spastoriza@nvidia.com>
Signed-off-by: Sam Pastoriza <spastoriza@nvidia.com>
Signed-off-by: Sam Pastoriza <spastoriza@nvidia.com>
@pastorsj pastorsj changed the title feat(catalog): generate searchable example pages from READMEs Generate searchable example pages from READMEs Aug 27, 2026
Signed-off-by: Sam Pastoriza <spastoriza@nvidia.com>
Signed-off-by: Sam Pastoriza <spastoriza@nvidia.com>
Signed-off-by: Sam Pastoriza <spastoriza@nvidia.com>
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