diff --git a/.github/workflows/verify-version-indexes.yml b/.github/workflows/verify-version-indexes.yml index b96b1a46..21256bee 100644 --- a/.github/workflows/verify-version-indexes.yml +++ b/.github/workflows/verify-version-indexes.yml @@ -3,6 +3,7 @@ name: Verify version indexes on: pull_request: paths: + - "README.md" - "v*/**/README.md" - "scripts/generate_version_indexes.py" - "requirements-dev.txt" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2fc2a691..9853a912 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -23,4 +23,4 @@ repos: pass_filenames: false additional_dependencies: - PyYAML==6.0.2 - files: ^(v\d.*/.*/README\.md|scripts/generate_version_indexes\.py)$ + files: ^(README\.md|v\d.*/.*/README\.md|scripts/generate_version_indexes\.py)$ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf5ceebf..3e5b3457 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -159,11 +159,11 @@ Before opening a PR, make sure you can complete this checklist from a clean envi python scripts/generate_version_indexes.py --check ``` -## Keep version README indexes in sync +## Keep template indexes in sync -Version README files (`v0.13/README.md`, `v0.14/README.md`, `v1/README.md`) are generated from template README metadata, specifically the `description` field in front matter. +The template index is generated from each template README's front matter — the `description`, `industry`, and `reasoning_types` fields. It is written to each version README (`v0.13/README.md`, `v0.14/README.md`, `v1/README.md`) and to the repository root `README.md`, between its `` / `` markers. -If you add a template or update a template description, regenerate the version indexes and commit the resulting README changes. +If you add a template or change a template's `description`, `industry`, or `reasoning_types`, regenerate the indexes and commit the resulting README changes. ```bash python scripts/generate_version_indexes.py diff --git a/README.md b/README.md index 57004130..ae8b71d1 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,7 @@ This repository contains runnable RelationalAI templates that demonstrate end-to Each template lives in its own folder with code, sample data, and a template-specific README. Templates are grouped into versioned directories so the repository can support multiple generations of examples side by side. -## Repository layout - -| Path | Purpose | -| --- | --- | -| [`sample-template/`](sample-template/) | Starting point for authoring a new template. Includes the expected file layout and README template. | -| [`v0.13/`](v0.13/) | Older templates for version `0.13` of the `relationalai` Python package. Included for reference, only. | -| [`v0.14/`](v0.14/) | Older templates for version `0.14` of the `relationalai` Python package. Included for reference, only. | -| [`v1/`](v1/) | Newer templates for versions `>=1.0` of the `relationalai` Python package. **Use these for new development.** | +## Templates Within a template folder, you will usually find: @@ -19,6 +12,125 @@ Within a template folder, you will usually find: - `pyproject.toml` for template-local dependencies - a main runner such as `