Which programming languages does this skill support?

The skill provides full parity and documentation standards for Rust, Python, TypeScript, Ruby, Java, Go, and C#.

Does it automatically create new documentation files?

No, the skill follows a strict rule of no proactive README or documentation creation; it only generates or updates content when specifically requested.

How are code snippets organized within the repository?

Snippets are stored in a structured directory format under docs/snippets/{language}/{category}/ and are integrated into docs using the MkDocs --8<-- syntax.

Can it verify if the code snippets are actually correct?

Yes, the skill is designed to verify API accuracy by reading source code before writing and testing snippets for functional correctness.

What documentation styles are enforced for inline comments?

It enforces Google style for Python, JSDoc for TypeScript, Javadoc for Java, XML doc comments for C#, and YARD for Ruby, ensuring platform-native readability.

Documentation Language Parity

Name: Documentation Language Parity
Author: kreuzberg-dev

bykreuzberg-dev

•

480

Learning & Documentation

Enforces strict documentation standards and ensures code snippet parity across seven major programming languages.

About

This skill automates the maintenance of high-quality, polyglot documentation for complex software ecosystems. It ensures that every technical guide and API reference includes synchronized, functional code examples for Rust, Python, TypeScript, Ruby, Java, Go, and C#. By enforcing specific directory structures, MkDocs tabbed formatting, and language-specific docstring standards (such as Javadoc, JSDoc, and YARD), it guarantees that developers receive a consistent experience regardless of their preferred programming language.

Key Features

Enforcement of language-specific inline doc standards (Javadoc, JSDoc, YARD, XML)
Cross-language API reference consistency and verification
Strict public API documentation requirements and safety comment enforcement
Automated MkDocs snippet integration using pymdownx.tabbed syntax
480 GitHub stars
Seven-language code snippet synchronization and validation

Use Cases

Standardizing inline documentation across large-scale multi-language repositories
Maintaining synchronized 'Getting Started' guides for polyglot SDKs and APIs
Automating the generation of tabbed code blocks for technical documentation sites

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add kreuzberg-dev/html-to-markdown documentation-standards-language-parity

For use in Claude.ai and ChatGPT

Download Skill

GitHub