Merged
Conversation
Signed-off-by: David Gageot <david.gageot@docker.com>
Add TestDocYAMLSnippetsAreValid which extracts every fenced YAML block from docs/ markdown files and validates that: 1. Every snippet is syntactically valid YAML. 2. Snippets that look like full agent configs (top-level keys match the schema root) are additionally validated against agent-schema.json. Blocks can be excluded with a <!-- yaml-lint:skip --> comment on the line before the opening fence. The test caught several doc bugs which are fixed in this commit: - RAG quick start had 'description' at the wrong nesting level - API tool examples used flat fields instead of 'api_config' nesting - Schema reference blocks used type names as placeholder values Assisted-By: cagent
derekmisler
approved these changes
Mar 4, 2026
|
❌ PR Review Failed — The review agent encountered an error and could not complete the review. View logs. |
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.
No description provided.