Review Doc Comments
Azure/azure-sdk-for-rust/.github/skills/review-doc-comments
codingOfficial
Official Provider SkillView repo
Write and review Rust public API documentation for clarity, accuracy, Microsoft style, useful links and sections, and buildable examples. Use for public API reviews even when doc comments did not change.
Files1 files
SKILL.md155 lines
Loading editor…
Install
RecommendedOne command — your agent picks it up automatically.
Select an AI agent above to see the install command.
or
Manual Install
More stepsDownload the file and paste it into your agent's system prompt.
Skill details
Versionv1.0.0
AuthorAzure
Categorycoding
Skill IDAzure/azure-sdk-for-rust/.github/skills/review-doc-comments
Related skills
Agentic WorkflowsRoute gh-aw workflow design/create/debug/upgrade requests to the right prompts.Analyze CodeRun repository code analysis as a final check after completing prompts, targeting every changed Rust package by PackageNames.Check SpellingCheck and fix spelling in project source files using cSpell.Cosmos Design StructEnforce consistent struct design conventions across sdk/cosmos crates. Validates visibility modifiers, field privacy, #[non_exhaustive] usage, and construction API patterns (`Default`/`new` with `with_*` setters, or optional separate builders with `builder()`/`build()`), and construction correctness on public structs. Can auto-fix violations or report them as errors.Cosmos Pre Commit ValidationRun pre-commit checks for a specific set of crates. Use this when validating changes under sdk/cosmos before committing or during code review.Create CrateCreate a new Azure SDK crate from a TypeSpec specification.