gum-docs-writing

Write Gum documentation in GitBook markdown with SUMMARY.md and image conventions.

597|79|Updated Mar 11, 2015
One-click install
npx skills add https://github.com/vchelaru/Gum --skill gum-docs-writing
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gum-docs-writing
Source: https://github.com/vchelaru/Gum/tree/main/.claude/skills/gum-docs-writing
Command: npx skills add https://github.com/vchelaru/Gum --skill gum-docs-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Authors of Gum documentation often struggle with inconsistent formatting, broken navigation, and improper image handling, leading to confusing GitBook sites.

Core Features & Use Cases

  • Provides clear rules for file placement, SUMMARY.md indentation, and section landing pages.
  • Defines image path conventions, hint and figure syntax, and code‑sample placement comments.
  • Guides authors on separating tool docs from code docs, ensuring consistent tone and style.

Quick Start

Request the gum-docs-writing skill to format a new documentation page and insert it into SUMMARY.md.

Frequently Asked Questions about gum-docs-writing

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

FAQPage Schema
How do I write GitBook documentation for Gum with proper markdown formatting?

To write GitBook documentation for Gum, you must follow structured markdown formatting rules for authoring docs, managing file placement, and applying syntax for hints, figures, and C# code snippets to ensure consistent site rendering.

How do I update SUMMARY.md navigation for a new GitBook documentation page?

Updating SUMMARY.md involves inserting the new page entry with correct indentation to maintain hierarchical navigation. You must also ensure proper section landing pages exist to prevent broken links and confusing site structures.

What is the correct image path convention for Gum documentation in GitBook?

The correct image path convention requires strictly adhering to Gum's specific directory structure and file path rules. Proper image path handling prevents broken visual assets and ensures images load correctly in the GitBook site.

How do I add C# code snippets to Gum GitBook docs?

Adding C# code snippets requires using specific placement comments defined by the Gum documentation guidelines. These placement comments ensure code samples are formatted correctly and separated properly from tool documentation.

Does the Gum documentation workflow separate tool docs from code docs?

Yes, the Gum documentation workflow enforces separating tool docs from code docs. This separation ensures a consistent tone and style across the GitBook site, preventing confusing overlaps between tool usage and code implementation details.

Why do my GitBook hint blocks break when writing Gum documentation?

GitBook hint blocks break when hint block closure syntax is not properly applied. Following the Gum documentation guidelines for proper hint block closure ensures these formatting blocks render correctly without breaking the page layout.