Skip to content

Commit 8529b81

Browse files
committed
fix inconsistencies
Signed-off-by: Kashish Mittal <kmittal@redhat.com>
1 parent 10d5256 commit 8529b81

6 files changed

Lines changed: 25 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,21 @@ Agent Skills for adopting and using [Red Hat Developer Hub](https://developers.r
1818

1919
Interactive authoring for RHDH Scaffolder templates — templatize an existing repo, create from scratch, fix common gotchas, and validate locally or against a running instance.
2020

21+
- **[rhdh-templates](./skills/rhdh-templates/SKILL.md)** — Interactive authoring and validation for Software Templates. Includes curated reference catalog (official library + AI quickstarts), worked examples (`nodejs-backend`, `java-springboot`) and bundled JSON Schema validation. Sub-commands:
22+
- **[init](./skills/rhdh-templates/references/init.md)** — Check tooling, scaffold template repo layout, optional RHDH connectivity.
23+
- **[templatize](./skills/rhdh-templates/references/templatize.md)** — Convert existing codebase into a parameterized template.
24+
- **[create](./skills/rhdh-templates/references/create.md)** — Guided from-scratch template authoring when no reference code exists.
25+
- **[add-parameter](./skills/rhdh-templates/references/add-parameter.md)** — Add a parameter or parameter group to existing `template.yaml`.
26+
- **[add-step](./skills/rhdh-templates/references/add-step.md)** — Add a scaffolder step to existing `template.yaml`.
27+
- **[add-skeleton](./skills/rhdh-templates/references/add-skeleton.md)** — Add or parameterize skeleton files with Nunjucks.
28+
- **[create-location](./skills/rhdh-templates/references/create-location.md)** — Generate or update root `location.yaml` for catalog registration.
29+
- **[fix-gotchas](./skills/rhdh-templates/references/fix-gotchas.md)** — Auto-fix common RHDH template mistakes (raw/endraw blocks, catalog-info path, etc.).
30+
- **[validate](./skills/rhdh-templates/references/validate.md)** — Local YAML schema, gotcha validation, and optional Nunjucks lint via `--lint-skeleton` (no RHDH required).
31+
- **[list-actions](./skills/rhdh-templates/references/list-actions.md)** — List available Scaffolder actions from a running RHDH instance.
32+
- **[dry-run](./skills/rhdh-templates/references/dry-run.md)** — Test template execution via Scaffolder v2 dry-run API.
33+
- **[explain-action](./skills/rhdh-templates/references/explain-action.md)** — Show action input schema or template parameter schema.
34+
- **[example-catalog](./skills/rhdh-templates/references/example-catalog.md)** — Browse curated reference templates (official library, AI quickstarts, bundled).
35+
2136
Example prompts:
2237

2338
- "Help me turn this Node.js repo into an RHDH Software Template"
@@ -78,6 +93,7 @@ npx skills add ./rhdh-users-skill-pack
7893
You can also name the skill explicitly:
7994

8095
```
96+
Use the rhdh-templates skill to validate my template.yaml
8197
Use the skill-maker skill to audit my SKILL.md
8298
```
8399

skills/rhdh-templates/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: >-
77
template", "golden path template", "parameterize skeleton files", "fix template
88
gotchas", "validate template", "dry-run template", "list scaffolder actions",
99
"explain scaffolder action", "Nunjucks in template", "template best practices",
10-
"reference templates", "example templates", "what templates do customers use",
10+
"reference templates", "example templates", "what templates are commonly used",
1111
"Template Editor", or mentions RHDH template
1212
authoring, Software Catalog templates, or /rhdh-templates commands. Covers setup,
1313
templatize (highest value), from-scratch create, reference example discovery,
@@ -96,7 +96,7 @@ Command descriptions and argument hints: `scripts/command-metadata.json`
9696
| 11, "dry-run", "dry run", "test template remotely" | [references/dry-run.md](references/dry-run.md) |
9797
| 12, "explain-action", "action schema", "parameter schema" | [references/explain-action.md](references/explain-action.md) |
9898
| 13, "examples", "reference templates", "show me templates", "what templates exist" | [references/example-catalog.md](references/example-catalog.md) |
99-
| First word doesn't match | Infer from context. "Turn my Spring Boot app into a template" → `templatize`. "Add owner picker to my template" → `add-parameter`. "Does my template validate?" → `validate`. "What templates do customers use?" → `examples`. |
99+
| First word doesn't match | Infer from context. "Turn my Spring Boot app into a template" → `templatize`. "Add owner picker to my template" → `add-parameter`. "Does my template validate?" → `validate`. "What example templates exist?" → `examples`. |
100100

101101
</routing>
102102

skills/rhdh-templates/assets/examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For the full curated catalog of upstream reference templates (official library,
88
python skills/rhdh-templates/scripts/list_examples.py --recommended --json
99
```
1010

11-
See [../references/example-catalog.md](../references/example-catalog.md) for category guide and customer-demand context.
11+
See [../references/example-catalog.md](../references/example-catalog.md) for category guide and common-demand context.
1212

1313
| Example | Stack | Highlights |
1414
|---------|-------|------------|

skills/rhdh-templates/references/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ python <skill-dir>/scripts/list_examples.py \
3737

3838
Present upstream URLs from the matches. When a match includes `local_bundled`, also point at `assets/examples/<name>/` for offline patterns. Ask whether to mirror a reference's step sequence or start from `assets/examples/minimal-template/`.
3939

40-
Load `example-catalog.md` when the user asks what customers typically build.
40+
Load `example-catalog.md` when the user asks what templates teams typically build.
4141

4242
## Step 2: Ensure layout
4343

skills/rhdh-templates/references/example-catalog.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<process>
1010

11-
Surface curated reference templates customers reach for most often. Use when the user asks "what templates exist?", "show me an example", "what do customers usually build?", or before `create` / `templatize` to pick a study reference.
11+
Surface curated reference templates teams reach for most often. Use when the user asks "what templates exist?", "show me an example", "what do teams usually build?", or before `create` / `templatize` to pick a study reference.
1212

1313
## Step 1: Parse intent
1414

@@ -70,7 +70,7 @@ Upstream templates in GitHub are **learning aids**, not production-ready golden
7070
| AI Lab samples | [ai-lab-template](https://github.com/redhat-ai-dev/ai-lab-template) | Smaller AI samples (RAG, chatbot, codegen) |
7171
| Bundled skill examples | `assets/examples/` in this skill | Local validation, minimal patterns without cloning repos |
7272

73-
## Categories (customer demand order)
73+
## Categories (common demand order)
7474

7575
1. **backend** — Go, Node.js, Spring Boot, Quarkus, Python services with CI (most common golden path)
7676
2. **catalog** — Register existing repos into the Software Catalog
@@ -93,15 +93,15 @@ Templates marked **recommended** upstream (`tags: recommended` in their `templat
9393
| AI / RAG / agent request | Prefer `ai-quickstart-templates` over generic backend examples |
9494
| Import-only workflow | Point at `register-component` |
9595

96-
Do not copy upstream skeletons wholesale into customer repos without review — study their **parameter forms**, **step sequences**, and **conventions**, then adapt.
96+
Do not copy upstream skeletons wholesale into target repos without review — study their **parameter forms**, **step sequences**, and **conventions**, then adapt.
9797

9898
## Catalog maintenance
9999

100100
Data lives in `assets/example-catalog.json`. Refresh when:
101101

102102
- `templates.yaml` changes in the official library
103103
- New AI quickstart templates ship
104-
- Field teams report a recurring customer pattern not yet listed
104+
- Teams report a recurring pattern not yet listed
105105

106106
Run `list_examples.py --json` after edits to verify parsing.
107107

tests/unit/test_claude_md.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,5 @@ def test_has_verification_command(self, agents_md):
5050
def test_has_available_skills_section(self, agents_md):
5151
"""AGENTS.md should list user-facing skills."""
5252
assert "## Available skills" in agents_md
53+
assert "rhdh-templates" in agents_md
5354
assert "skill-maker" in agents_md

0 commit comments

Comments
 (0)