docs-writer

Write and edit Gemini CLI markdown documentation with verified accuracy and style consistency.

Updated Aug 30, 2025
One-click install
npx skills add https://github.com/vonomarap/kanokna --skill docs-writer-vonomarap
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/vonomarap/kanokna/tree/main/.agents/skills/docs-writer
Command: npx skills add https://github.com/vonomarap/kanokna --skill docs-writer-vonomarap

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Ensure Gemini CLI documentation and markdown files are accurate, consistent, and easy for users to follow, reducing confusion and maintenance overhead.

Core Features & Use Cases

  • Documentation authoring and editing: Create new pages or revise existing .md files to improve clarity, tone, and structure.
  • Implementation verification: Inspect repository code to confirm examples, flags, and behaviors are correct before updating docs.
  • Style and link consistency: Enforce the project's style-guide, fix broken links, and update navigation such as sidebar entries when adding pages.
  • Use Case: Update a command reference page to reflect recent CLI behavior changes, correct examples, and ensure all cross-links remain valid.

Quick Start

Use the docs-writer skill to update a specified docs/*.md file to match implementation, follow the style guide, and fix any broken links.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I update markdown documentation to match code changes?

To update markdown documentation, inspect repository code to confirm examples and flags are correct, then revise the .md files to improve clarity and enforce the project's style guide.

How do I fix broken links in technical writing?

Fix broken links in technical writing by checking and repairing cross-links within the markdown files. You should also update navigation entries like sidebars when adding or removing pages.

What is the best way to ensure style consistency in CLI documentation?

Ensure style consistency in CLI documentation by applying the project's style guide across all edited .md files, correcting formatting, tone, and structure during the documentation editing process.

Can I use this approach to verify markdown examples against repository code?

Yes, you can verify markdown examples against repository code. The process involves inspecting the codebase to confirm that command examples, flags, and behaviors are accurate before updating docs.

Do I need to run a formatting command after editing markdown files?

Yes, you should run a formatting command after editing markdown files. The process suggests running the project's specific formatting command to ensure the updated documentation meets repository standards.

What is the process for adding new pages to CLI documentation?

Adding new pages to CLI documentation involves authoring the content, verifying implementation details, enforcing the style guide, and updating navigation elements like sidebar entries to include the new page.