gabe-docs

Codify Gabe Docs documentation standards for CommonMark and Mermaid diagrams.

Updated Feb 19, 2026
One-click install
npx skills add https://github.com/Brownbull/gabe-suite --skill gabe-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gabe-docs
Source: https://github.com/Brownbull/gabe-suite/tree/main/skills/gabe-docs
Command: npx skills add https://github.com/Brownbull/gabe-suite --skill gabe-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Gabe Docs defines and enforces a house style for all Markdown docs produced by the Gabe Suite, ensuring consistency, readability, and predictable rendering across tools and audiences.

Core Features & Use Cases

  • Documentation standards: CommonMark compliance, Mermaid diagram selection, analogy-first openers, and per-well diagram guidance.
  • Workflow integration: guides how docs are authored for /gabe-teach, /gabe-init, /gabe-commit, and how rendering respects spec-meta fences and diagram budgets.

Quick Start

Follow the Gabe Docs template to draft documentation that adheres to the official rules and conventions.

Frequently Asked Questions about gabe-docs

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

FAQPage Schema
How do I enforce CommonMark compliance and frontmatter rules in generated Markdown documentation?

To enforce CommonMark compliance and frontmatter rules in generated Markdown documentation, you apply codified house style standards that mandate explicit frontmatter fields and strict Markdown syntax to ensure consistent, readable rendering across tools.

What is the best way to manage Mermaid diagram conventions and limits in Markdown docs?

Managing Mermaid diagram conventions involves applying per-well diagram guidance and diagram budgets to limit the number of rendered diagrams, preventing rendering fatigue and maintaining predictable documentation structure.

How do I standardize Markdown documentation across automated commit and init workflows?

You can standardize Markdown documentation across automated workflows by integrating house style rules that guide how docs are authored during init, commit, and teach operations, ensuring consistent output and developer guidance.

Does this documentation standard support custom spec-meta fence handling for runtime rendering?

Yes, the documentation standard enforces spec-meta fence handling to guarantee reliable runtime rendering, ensuring that custom metadata blocks within Markdown are processed correctly and predictably by downstream tools.

What are the limitations of using strict Markdown house styles for automated doc generation?

Strict Markdown house styles limit doc generation by enforcing diagram budgets and explicit frontmatter, which may restrict free-form content creation but ensures predictable rendering and structural consistency across all generated outputs.

When do I need to use explicit frontmatter in Markdown documentation?

You need explicit frontmatter in Markdown documentation when relying on automated rendering pipelines, as mandatory frontmatter fields provide the metadata required to guarantee reliable runtime processing and consistent developer guidance.