Move templates library index to root README; enrich and normalize by industry#82
Open
cafzal wants to merge 1 commit into
Open
Move templates library index to root README; enrich and normalize by industry#82cafzal wants to merge 1 commit into
cafzal wants to merge 1 commit into
Conversation
- Restructure root README: replace "Repository layout" with a "Templates" section (per-folder contents list, now including runbook.md) plus a generated, collapsible-by-industry index - generate_version_indexes.py now extracts industry + reasoning_types and writes the index to both the root README (between markers) and each version README, grouped by industry - Normalize industry frontmatter into 8 coarse, mutually-exclusive buckets across all version dirs - Update CONTRIBUTING, pre-commit, and the verify-version-indexes workflow to cover the root README and the new front-matter fields
|
The docs preview for this pull request has been deployed to Vercel!
|
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.
Moves the template library index into the repository root README and makes it generated, richer, and grouped by a consolidated industry taxonomy.
Changes
README.md: theRepository layoutsection becomes aTemplatessection — the per-folder contents list (now includingrunbook.md: ordered prompts to recreate or adapt a template with a coding agent + RAI skills) followed by a generated, collapsible-by-industry index of the current (v1) templates, each row showing its reasoners and description.scripts/generate_version_indexes.py: now readsindustryandreasoning_typesfrom front matter and writes the collapsible, industry-grouped index to both the root README (between<!-- BEGIN/END TEMPLATE INDEX -->markers) and each version README.industrylabels are consolidated into 8 coarse, mutually-exclusive buckets across all version dirs — Financial Services, Healthcare & Life Sciences, Manufacturing, Retail & Consumer, Technology & Telecom, Energy & Utilities, Supply Chain & Logistics, Cross-Industry.CONTRIBUTING.md,.pre-commit-config.yaml, and theverify-version-indexesworkflow updated to cover the root README and the additional front-matter fields.Notes
python scripts/generate_version_indexes.py --checkpasses.industryis a free-form string in the docstemplates:syncvalidator (onlyreasoning_typesis enum-gated), so the new buckets require norelationalai-docschange.