Enhance generation rules documentation and examples#807
Merged
Conversation
- 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.
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ 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 |
There was a problem hiding this comment.
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.
Reviewed by Cursor Bugbot for commit 5ddaefb. Configure here.
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
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.


generation-rules-guide.mdto clarify platform specifications and resource type matching, including the addition ofrunwhenas a supported platform.README.mdandgeneration-rules/README.mdto reflect new structures and naming conventions for SLXs.matchRulessyntax and clarified the use ofresourceTypes.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: writebut does not change runtime indexer or workspace-builder logic.Overview
Aligns authoring docs with the current
GenerationRulesYAML model (spec.platform,resourceTypes,matchRules,slxs,outputItems) and deprecates the older single-GenerationRule/ jsonpath examples in favor ofgeneration-rules-guide.mdand 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-catalogGHA that runsdump_*_resource_catalog.pyand commits*-resource-catalog.mdon indexer/registry changes. Newauthor-generation-rulesCursor skill points airgap MCP at bundled references;sync_authoring_to_docs_site.pyoptionally 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 dropsrelatedResourcesin 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.