Support new guide paradigm with rule and template files - #698
Merged
Merged
Conversation
Contributor
Devon-White
approved these changes
Sep 17, 2026
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
2 participants
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.
Description
Adds
mdx-capability-guides, a path-scoped rule for how-tos that teach one capability across several surfaces, and cross-references it frommdx-style,mdx-components,mdx-diagrams, andCLAUDE.md. The rule reconciles the template from #640 (write guides, record calls) with the guides in #660, #692, and #693: surfaces get###headings, with tabs only inside<Steps>; the capability matrix takes every surface column plus a planned state; Relay and the REST Calling API share one code block set when only the transport differs; SWML is one surface, authored withAgentBasefirst and delivered once per guide; samples are complete programs with pinned versions;## Next stepsstays required. Contributor guidance only, no page changes.Type of Change
Related Issues
closes #700
Testing
Testing on a rewrite of #682
Checklist