docs(skill): align the omnigraph skill with 0.8.1#339
Merged
Conversation
- Undirected traversal documented (SKILL.md quick-rules + embedded
grammar + references/queries.md worked example, marked >= 0.8.1).
- Enum widening documented as a supported metadata-only apply
(references/schema.md), with the still-refused shapes listed.
- Two standing inaccuracies fixed: `{1,}` was documented as unbounded
traversal but the typechecker rejects unbounded (T15); the
required-property recipe's final "tighten to required" step is refused
by the planner (OG-MF-106) — the recipe now says to keep the property
optional until required-tightening ships.
- Skill metadata version -> 0.8.1; compatibility note marks the
version-gated features.
…ote, example naming Devin caught the gotchas table still advising the tighten-in-follow-up recipe this PR corrects elsewhere; the D2 note claiming deletes inline-commit (staged since 0.8.0 — the rule is a deliberate boundary, not an implementation gap); and the undirected example describing `Related` while traversing `<issueRelated>` (text now names `IssueRelated` per the PascalCase->lowerCamelCase convention).
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.
Post-release alignment sweep for v0.8.1, skill portion.
$a <edge> $b) added to the quick rules, the embedded grammar excerpt, andreferences/queries.md(worked example; T22 rule; composition with bounds/not{}) — marked>= 0.8.1.references/schema.mdas a supported metadata-only apply; narrowing/rename/enum↔String noted as still refused.{1,}= unbounded traversal (the typechecker rejects unbounded, T15), and the required-property recipe ended with "tighten to required in a follow-up apply" (refused by the planner as a property-type change, OG-MF-106). Both corrected to match engine behavior.version→ 0.8.1; compatibility line marks version-gated features.Rest of the sweep (verified aligned, no changes needed): README (no version-bearing claims), docs/ (no stale 0.8.0 refs outside history), Homebrew tap (auto-updated to v0.8.1 by release.yml), omnigraph-ts (0.8.0 sync merged; 0.8.1 sync to follow via its pipeline), omnigraph-web (doc re-sync remains deferred pending the flat-only import script fix).
Greptile Summary
This PR aligns the omnigraph skill with the v0.8.1 release by adding new features and correcting two pre-existing inaccuracies discovered during the sweep.
$a <edge> $b, >= 0.8.1) added to quick rules, the embedded PEG grammar excerpt, andreferences/queries.mdwith a worked example, T22 rule (asymmetric-edge rejection), and bounds/not{}composition notes.references/schema.mdas a supported metadata-onlyschema apply(narrowing/rename/enum↔String remain refused per OG-MF-106).{1,}equals unbounded traversal has been fixed to state the typechecker rejects unbounded bounds outright ("unbounded traversal is disabled"); Corrected: required-property recipe — step 4 formerly advised tighteningT?→Tin a follow-up apply, which the planner actively refuses (OG-MF-106); both thereferences/schema.mdrecipe and the Common Gotchas table inSKILL.mdnow reflect the correct behavior.Confidence Score: 5/5
Documentation-only change correcting two previously inaccurate gotchas and adding two new 0.8.1 features; all edits are internally consistent across the three skill files and cross-check cleanly against AGENTS.md.
Every factual claim in the diff was cross-verified: undirected traversal semantics (T22, deduplication, bounds composition) align with AGENTS.md's GraphIndex/CSR description; the bounded-only traversal correction matches the stated typecheck behaviour; enum widening as metadata-only apply is consistent with the schema.md supported-types section; the D₂ explanation update matches the staged-delete path described in AGENTS.md. The prior P1 finding (stale gotcha advising a refused schema apply) is addressed in both SKILL.md and references/schema.md. No logic, runtime, or contract changes are introduced.
No files require special attention; all three changed files are consistent with each other and with AGENTS.md.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A["Traversal in .gq match block"] --> B{Edge brackets?} B -- "directional\n$p edge $q" --> C["Directional traversal\n(all engine versions)"] B -- "undirected\n$p <edge> $q\n>= 0.8.1" --> D{Same endpoint type?} D -- "yes\ne.g. Issue -> Issue" --> E["Undirected match\n(either direction, deduplicated)"] D -- "no\ne.g. Comment -> Issue" --> F["Rejected: T22\nasymmetric edge"] C --> G{Hop bounds?} E --> G G -- "{n,m} finite" --> H["Variable-hop traversal"] G -- "{n,} unbounded" --> I["Rejected: T15\nunbounded disabled"] G -- "none" --> J["Single-hop traversal"]%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% flowchart TD A["Traversal in .gq match block"] --> B{Edge brackets?} B -- "directional\n$p edge $q" --> C["Directional traversal\n(all engine versions)"] B -- "undirected\n$p <edge> $q\n>= 0.8.1" --> D{Same endpoint type?} D -- "yes\ne.g. Issue -> Issue" --> E["Undirected match\n(either direction, deduplicated)"] D -- "no\ne.g. Comment -> Issue" --> F["Rejected: T22\nasymmetric edge"] C --> G{Hop bounds?} E --> G G -- "{n,m} finite" --> H["Variable-hop traversal"] G -- "{n,} unbounded" --> I["Rejected: T15\nunbounded disabled"] G -- "none" --> J["Single-hop traversal"]Comments Outside Diff (1)
skills/omnigraph/SKILL.md, line 380 (link)The PR corrects the inaccurate step-4 text in
references/schema.md(tighteningT?→Tis refused, OG-MF-106), but the matching "Common Gotchas" row in SKILL.md still ends with "Make optional → backfill → tighten in follow-up apply". An agent following only the main SKILL.md (the default load path) will be advised to attempt aschema applythat the planner actively refuses, which is the exact footgun this PR was targeting.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Reviews (2): Last reviewed commit: "docs(skill): review follow-ups — gotcha-..." | Re-trigger Greptile