Skip to content

Enhance generation rules documentation and examples#807

Merged
stewartshea merged 3 commits into
mainfrom
discovery/custom-tool-builder-slxs
Jul 7, 2026
Merged

Enhance generation rules documentation and examples#807
stewartshea merged 3 commits into
mainfrom
discovery/custom-tool-builder-slxs

Conversation

@stewartshea

@stewartshea stewartshea commented Jul 2, 2026

Copy link
Copy Markdown
Contributor
  • Updated generation-rules-guide.md to clarify platform specifications and resource type matching, including the addition of runwhen as a supported platform.
  • Improved examples in README.md and generation-rules/README.md to reflect new structures and naming conventions for SLXs.
  • Refactored generation rule examples to utilize the new matchRules syntax and clarified the use of resourceTypes.
  • Enhanced documentation for indexed resources, including updates to the Azure resource catalog and the overall structure of indexed resource references.
  • Added new examples demonstrating multi-resource contexts and improved clarity on related resource handling in SLXs.

This update aims to provide clearer guidance for authors creating generation rules and improve the overall usability of the documentation.


Note

Low Risk
Documentation, generated markdown, and optional docs sync only; the new GHA can push catalog commits to branches with contents: write but does not change runtime indexer or workspace-builder logic.

Overview
Aligns authoring docs with the current GenerationRules YAML model (spec.platform, resourceTypes, matchRules, slxs, outputItems) and deprecates the older single-GenerationRule / jsonpath examples in favor of generation-rules-guide.md and Workspace Explorer for validation.

Adds machine-readable indexed-resource catalogs for AWS, GCP, Kubernetes, and RunWhen platform (plus refreshed Azure catalog metadata), wired to publish-discovery-catalog GHA that runs dump_*_resource_catalog.py and commits *-resource-catalog.md on indexer/registry changes. New author-generation-rules Cursor skill points airgap MCP at bundled references; sync_authoring_to_docs_site.py optionally mirrors this tree into the Starlight docs repo.

Worked examples and indexed-resources README are rewritten for .runwhen/templates/, match_resource, and qualifier-based SLX naming; the multi-resource example drops relatedResources in favor of IDs on the primary resource and workspace map rules for cross-SLX graphs.

Reviewed by Cursor Bugbot for commit f669bdd. Bugbot is set up for automated code reviews on this repo. Configure here.

- Updated `generation-rules-guide.md` to clarify platform specifications and resource type matching, including the addition of `runwhen` as a supported platform.
- Improved examples in `README.md` and `generation-rules/README.md` to reflect new structures and naming conventions for SLXs.
- Refactored generation rule examples to utilize the new `matchRules` syntax and clarified the use of `resourceTypes`.
- Enhanced documentation for indexed resources, including updates to the Azure resource catalog and the overall structure of indexed resource references.
- Added new examples demonstrating multi-resource contexts and improved clarity on related resource handling in SLXs.

This update aims to provide clearer guidance for authors creating generation rules and improve the overall usability of the documentation.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 5ddaefb. Configure here.

- type: pattern
pattern: "prod"
properties: [tags]
mode: substring

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prod tag match too broad

Medium Severity

The updated VM example scopes on pattern: "prod" with properties: [tags] and substring mode, which matches any tag key or value containing prod, not specifically environment: prod as the narrative describes. VMs with unrelated tags can still generate disk-health SLXs.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 5ddaefb. Configure here.

@stewartshea stewartshea merged commit 101a57d into main Jul 7, 2026
21 of 22 checks passed
@stewartshea stewartshea deleted the discovery/custom-tool-builder-slxs branch July 7, 2026 02:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant