Align KDoc comments and MkDocs documentation to maintain a single source of truth.
npx skills add https://github.com/proto-at-block/bitkey --skill edit-docs
Please help me install this Agent Skill. Skill: edit-docs Source: https://github.com/proto-at-block/bitkey/tree/main/app/ai-rules/skills/edit-docs Command: npx skills add https://github.com/proto-at-block/bitkey --skill edit-docs
This skill helps maintain a single source of truth for documentation by aligning code comments (KDoc) and MkDocs-driven docs, reducing drift and inconsistencies across a codebase.
Update KDoc and MkDocs to reflect the latest API changes across modules in one pass.
High-intent search queries and answers about installing and using this skill.
To maintain consistent KDoc and MkDocs documentation, edit both simultaneously to reflect current API behavior. This enforces a single source of truth, reducing drift and ensuring references stay up-to-date across modules.
The best way to update documentation for a new API surface is to consolidate duplicates and edit both KDoc and MkDocs together. This enforces documented patterns, ensuring accuracy and coherence across mobile and backend components.
Enforcing a single source of truth reduces documentation drift by aligning KDoc and MkDocs layouts and patterns. It guides updates and consolidates duplicates, preventing inconsistencies across codebases with mobile and backend components.
Yes, you can align documentation for projects spanning both mobile and backend components. The process enforces consistent KDoc and MkDocs patterns, ensuring cross-linking and non-duplication across diverse software modules.
To consolidate duplicate documentation, edit KDoc and MkDocs together to reflect the latest API changes. This enforces non-duplication and ensures accuracy by maintaining a single source of truth across all references.
KrystianYCSilvaWrite KDoc comments and configure the Dokka Gradle plugin for Kotlin Multiplatform documentation.
JongsixGenerate technical documentation from source code and API definitions.
VMAFxRebuild mkdocs-material sites and detect broken links and ADR drift.
zenobi-usAutomate API documentation creation and maintenance with OpenAPI integration.
