feat: add samples.json manifest for downstream catalogs - #302
Open
tmoreton wants to merge 2 commits into
Open
Conversation
added 2 commits
September 3, 2026 09:54
Add a machine-readable index of every sample (id, language, category, title, description, tags, path, GitHub URL, notebook) so consumers like the docs site can render a styled, grouped, filterable catalog without scraping README prose.
Regenerate the manifest with `node generate-samples-manifest.mjs` after adding or changing samples, so samples.json never drifts from the tree.
|
Latest scan for commit: ✅ Security Scan Report (PR Files Only)Scanned Files
Security Scan Results
Threshold: High No security issues detected in your changes. Great job! This scan only covers files changed in this PR. |
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
1 participant
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.
What
Adds
samples.json— a machine-readable index of every sample in the repo — plusgenerate-samples-manifest.mjs, the script that produces it from the repo tree.Each entry carries:
id,language,category+categoryLabel,title,description,tags,path, GitHuburl, andnotebook(when present). Categories are listed in their numbered order for grouped rendering.Why
Downstream consumers — starting with the docs site (strandsagents.com) examples page — currently can't render a styled, grouped, filterable catalog of samples without scraping README prose, which is brittle. A committed manifest gives them structured metadata to read directly, and lets this repo own the card copy.
How it's built
node generate-samples-manifest.mjswalkspython/**andtypescript/**, treats the shallowest README/notebook-bearing directory under each category as a sample, derives the category from the numbered folder, and lifts each title/description/tags from the curated category-README tables — falling back to the sample README's first paragraph so every entry has a blurb. Re-run it after adding or changing samples.Covers 86 samples across 8 Python + 2 TypeScript categories.