Skills
.Work. You
Rest

doc-example-generator

Official

Create verified TypeSpec docs with real code samples

Software Engineering#documentation#code generation#typespec#azure sdk#emitters#api examples
AuthorAzure
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill solves the challenge of creating trustworthy TypeSpec documentation examples by validating source code and replacing manually written snippets with verified emitter-generated API samples.

Core Features & Use Cases

  • Compilation Verification: Builds temporary TypeSpec projects and confirms examples compile successfully before documentation use.
  • Multi-language Example Generation: Runs Azure TypeSpec emitters to extract public API surfaces for Python, C#, TypeScript, Java, and Go documentation tabs.
  • Use Case: Documentation authors can use this Skill when adding client customization, paging, long-running operation, or model examples that require accurate generated SDK code.

Quick Start

Generate a verified ClientTabs documentation example for the TypeSpec feature I am documenting.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-example-generator
Download link: https://github.com/Azure/typespec-azure/archive/main.zip#doc-example-generator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 545,000+ vetted skills library on demand.