docs: address Copilot review on editor-integration guide - #40
Merged
Conversation
- Local-schema modeline example now uses ../schema/... to match the workflows/ layout the rest of the page uses (./schema/... would not resolve there) - VS Code yaml.schemas example includes the .yaml-workflow.yml pattern to match the documented convention
There was a problem hiding this comment.
Pull request overview
Updates the Editor Integration guide to align the examples with the documented repository layout and filename conventions, improving copy/paste correctness for local schema usage and VS Code schema mappings.
Changes:
- Clarifies that the local
$schemapath in the modeline is relative to the workflow file, and updates the example to use../schema/...for aworkflows/layout. - Extends the VS Code
yaml.schemasexample to include both**/*.yaml-workflow.yamland**/*.yaml-workflow.ymlpatterns.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Follow-up to #39 (merged) addressing Copilot's two doc-consistency comments:
./schema/..., which wouldn't resolve for workflow files underworkflows/(the layout the rest of the page uses). Changed to../schema/...with an explicit note that the path is relative to the workflow file.yaml.schemasexample listed only the.yaml-workflow.yamlpattern; added.yaml-workflow.ymlto match the documented convention.Docs-only;
mkdocs buildsucceeds.