feat(skill-creator): add references/examples.md specification section#392
Open
arimu1 wants to merge 1 commit into
Open
feat(skill-creator): add references/examples.md specification section#392arimu1 wants to merge 1 commit into
arimu1 wants to merge 1 commit into
Conversation
Comment on lines
+161
to
+164
| 5. **Client Creation**: Show ALL supported auth methods, each as an H3: | ||
| - Service-specific credential (API key, shared key, connection string) | ||
| - DefaultAzureCredential (mark as `"Recommended"`) | ||
| - Async client variant |
| 5. For Azure SDK skills, structure `references/` as: | ||
| - `references/capabilities.md` as a concise index that records each hero scenario and where it is covered (`SKILL.md` or a bundled reference), plus links to deeper non-hero references, with no historical/migration narration. | ||
| - `references/non-hero-scenarios.md` for concrete non-hero examples that are intentionally kept out of the main `SKILL.md`. | ||
| - `references/examples.md` for comprehensive, runnable code examples covering all major SDK operations. |
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.
Fixes #311
Summary
Adds the structured specification for
references/examples.md(required for all SDK skills) to.github/skills/skill-creator/SKILL.md.Key Changes
### Reference File: references/examples.md (Required for all SDK skills)inSKILL.mdspecifying the required 10-section structure (Title, One-line description, Table of Contents, Dependency/Installation, Client Creation, Operation Sections, Error Handling, Complete Application Example, Environment Variables, Best Practices) and authoring rules.SKILL.mdto explicitly includereferences/examples.mdalongsidecapabilities.mdandnon-hero-scenarios.md.Validation
SKILL.mdusingpython3 .github/skills/skill-creator/scripts/quick_validate.py .github/skills/skill-creator.