verify-docs-kotlin

Extract Kotlin code blocks from docs-db YAML files and compile them via Gradle.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Kotlin code examples in docs-db YAML files sometimes fail to compile, making it hard to verify correctness after translation and documentation generation.

Core Features & Use Cases

  • Extracts kotlin blocks from docs-db YAML entries and generates a compilable Kotlin test suite.
  • Runs the Kotlin Gradle verification to ensure every example compiles correctly.
  • Applies to documentation workflows where Kotlin examples are translated and validated before publishing.

Quick Start

Generate the Kotlin compile tests from docs-db with python3 scripts/generate_docs_compile_test.py, then run the Gradle task to verify all examples compile.

Frequently Asked Questions about verify-docs-kotlin

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

FAQPage Schema
How do I verify Kotlin code blocks in YAML documentation files compile correctly?

To verify Kotlin code blocks in YAML docs, generate a compilable Kotlin test suite from the YAML entries using a Python script, then run the Kotlin Gradle task to confirm every example compiles successfully.

What is the best way to validate translated Kotlin examples before publishing documentation?

Validating translated Kotlin examples involves extracting code blocks from docs-db YAML files, generating a Kotlin test suite, and running Gradle verification to ensure all translated examples compile correctly before publishing.

Do I need a specific Gradle setup to compile Kotlin code blocks from docs-db?

Yes, you need the configured BackgroundGeolocation Gradle setup and the docs-db directory containing the YAML files, along with the Python script to generate the compile tests from the documentation entries.

Can I automate testing of Kotlin code snippets in YAML files without manually checking each one?

Yes, automation is possible by running the Python script to extract all Kotlin blocks from YAML files and generate a test suite, then executing the Gradle task to compile and verify every example automatically.

Why does my Kotlin documentation example fail to compile after translation?

Kotlin documentation examples may fail to compile after translation due to syntax errors or incompatible code changes introduced during the translation and documentation generation process, requiring compilation verification.

What are the limitations of using Gradle to verify Kotlin code blocks in docs?

The Gradle verification approach requires the specific BackgroundGeolocation setup and docs-db directory structure, meaning it is tailored to that environment and may not directly apply to arbitrary documentation formats.