Collection catalogs - YAML schema validation, and authoring tooling#57
Conversation
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
…YAML schema for catalog validation - Replaced `catalog/collection.schema.json` with `catalog/schema.yaml` for JSON Schema in YAML format. - Updated references in `CLAUDE.md`, `COLLECTION_SPEC.md`, and various skill documentation to point to the new YAML schema. - Enhanced validation scripts to accommodate the new schema format and enforce inline length limits for documentation. - Added new documentation fragments for `mcp_section`, `security_model`, and `documentation_section` to improve clarity on usage and configuration. This change streamlines the catalog validation process and improves documentation consistency across the repository. Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Gemini Code Review1. SummaryThis PR introduces a comprehensive collection catalog specification ( 2. Project Rules ComplianceThere are a few violations of the strict skill design principles in the newly added repository skills (
3. Code Quality Issues
4. Suggestions
5. VerdictREQUEST_CHANGES — Please fix the mandatory section headings, add the missing HitL section to the file-modifying skill, and correct the Automated review by Gemini 3.1 Pro | Rules: CLAUDE.md, SKILL_DESIGN_PRINCIPLES.md |
…fragment references - Updated `COLLECTION_SPEC.md` to clarify the usage of inline markdown and fragment references for `deploy_and_use`, `documentation_section`, `mcp_section`, and `security_model`. - Modified validation scripts to reject legacy `*_file` keys and enforce the new reference structure. - Adjusted schema definitions in `catalog/schema.yaml` to reflect the changes in documentation structure. - Updated collection files in `rh-developer` and `rh-sre` to replace `*_file` keys with direct references. This change enhances consistency in documentation and validation processes across the repository. Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Great hint but out of scope for the current PR. |
- Updated `COLLECTION_SPEC.md` to clarify machine validation requirements and the need for AI semantic alignment reviews against golden sources. - Revised `SKILL.md` to emphasize the importance of semantic alignment and added new drift conditions for installation and environment variables. - Modified `deploy_and_use.md` files across multiple modules to replace Claude Code installation instructions with Lola commands for consistency. These changes improve the clarity and accuracy of documentation, ensuring better compliance with validation standards and installation procedures. Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
r2dedios
left a comment
There was a problem hiding this comment.
Great job :) Just have a few questions to check
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
- Added information about the `RHOAI_MCP_TRANSPORT` environment variable in both `README.md` and `deploy_and_use.md`, clarifying its default setting and export requirements. Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Summary
This branch introduces a machine-readable catalog per pack under /.catalog/ (collection.yaml plus a deterministic collection.json mirror and supporting fragments such as deploy_and_use.md), aligned with COLLECTION_SPEC.md and catalog/schema.yaml.
What changed
Pack(s) affected
allrh-srerh-developerocp-adminrh-virtrh-ai-engineerChange type
mcps.json)CLAUDE.md compliance
${VAR}referencesValidation
make validatepasses locallyname,description)name,description)