apply-docs-kotlin

Apply YAML documentation from docs-db to Android SDK Kotlin source files.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/transistorsoft/docforge --skill apply-docs-kotlin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: apply-docs-kotlin
Source: https://github.com/transistorsoft/docforge/tree/main/skills/apply-docs-kotlin
Command: npx skills add https://github.com/transistorsoft/docforge --skill apply-docs-kotlin

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) components.

What problem does it solve?

YAML-based documentation can be automatically embedded into Kotlin source files to keep in-code docs synchronized with the docs database.

Core Features & Use Cases

  • Reads YAML entries from the docs-db and maps them to Kotlin declarations (classes, methods, properties).
  • Updates or creates KDoc comments above the corresponding Kotlin symbols, handling flattened types, enums, and examples.
  • Supports applying documentation to the Android SDK's Kotlin sources, config, and event types for consistent API docs.

Quick Start

Run the Kotlin doc-applier to apply YAML docs to the Android Kotlin sources.

Frequently Asked Questions about apply-docs-kotlin

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically apply YAML documentation to Kotlin source files in Android?

To apply YAML documentation to Kotlin source files in Android, use a script that reads entries from a docs database and maps them to Kotlin declarations. It generates and inserts KDoc comments directly above the corresponding classes and members.

What is the best way to generate KDoc comments from a YAML docs database?

Generating KDoc comments from a YAML docs database involves mapping document IDs to Kotlin declarations. The automation script handles flattened types, enum replacements, and example blocks to ensure in-code documentation stays synchronized with the database.

Can I sync YAML documentation with Android Kotlin sources automatically?

Yes, you can sync YAML documentation with Android Kotlin sources automatically by running the doc-applier script. It updates or creates KDoc comments above the corresponding Kotlin symbols, keeping your in-code docs synchronized with the docs database.

Does applying YAML docs to Kotlin sources support cross-reference conversion and code samples?

Yes, applying YAML docs to Kotlin sources supports cross-reference conversion and code samples. The script handles these conversions alongside enum replacements and example blocks when mapping the documentation to the Kotlin declarations.

Do I need pyyaml to apply harvested YAML documentation to Kotlin declarations?

Yes, you need pyyaml installed to apply harvested YAML documentation to Kotlin declarations. The script relies on this dependency to parse the YAML entries from the docs database before mapping them to the Android Kotlin source files.