Added a Skill to examine the code snippets in markdown files.#6212
Open
happyhuman wants to merge 9 commits into
Open
Added a Skill to examine the code snippets in markdown files.#6212happyhuman wants to merge 9 commits into
happyhuman wants to merge 9 commits into
Conversation
Introduce the adk-verify-snippets developer skill to automate syntax, import, and runnability validation of Python code blocks inside Markdown documentation guides.
…rting to verify_md script
…ge reports in .gitignore
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.
Link to Issue or Description of Change
Describe the change:
Problem:
Some of the AI-generated code snippets may not be syntactically correct, or runnable. We need to identify them.
Issue: #6211
Solution:
This PR provides a Skill to examine the existing code snippets in a given markdown file (or a folder containing multiple markdown files) and check whether they load properly and/or run. It generates a report at the end with its findings.
Testing Plan
Manual End-to-End (E2E) Tests:
I tested the skill against a number of different existing markdown files under docs/guides using both Gemini and CloudCode. For instance, I use the following prompts in CloudCode & Gemini:
I also simultaneously used both Gemini and CloudCode to improve the skill.
Checklist