Skills
.Work. You
Rest

polyglot-api-documentation-examples

Official

Ensure comprehensive API documentation.

Software Engineering#typescript#documentation#api#python#rust#examples#polyglot
Authorkreuzberg-dev
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the critical need for complete and consistent API documentation across all supported programming languages, ensuring developers have clear, example-driven guidance.

Core Features & Use Cases

  • Language Parity: Mandates documentation examples in all 10 supported languages (Rust, Python, TypeScript, Ruby, PHP, Java, Go, C#, Elixir, WASM).
  • Structured Documentation: Defines a comprehensive API documentation structure including summary, description, parameters, return values, examples, related APIs, error cases, performance notes, and deprecation status.
  • Use Case: When a new public API function is added to the core Rust library, this Skill ensures that equivalent, runnable examples and detailed explanations are immediately generated and maintained for all other language bindings, preventing documentation drift and improving developer onboarding.

Quick Start

Ensure the new Rust function calculate_metrics has documentation examples in all 10 supported languages.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: polyglot-api-documentation-examples
Download link: https://github.com/kreuzberg-dev/html-to-markdown/archive/main.zip#polyglot-api-documentation-examples

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 223,000+ vetted skills library on demand.