write-docs

Write and update Inkeep docs site pages with frontmatter and content patterns.

1.4k|162|Updated Sep 5, 2025
One-click install
npx skills add https://github.com/inkeep/agents --skill write-docs-inkeep
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/inkeep/agents/tree/main/.agents/skills/write-docs
Command: npx skills add https://github.com/inkeep/agents --skill write-docs-inkeep

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams write and maintain clear, consistent documentation for the Inkeep docs site (agents-docs package). It consolidates best practices and frontmatter-driven templates to reduce drift between pages and speed up publishing.

Core Features & Use Cases

  • Frontmatter-driven metadata for pages (title, description, keywords, etc.)
  • Documentation patterns for Reference, Tutorial, Overview, and Integration pages
  • Reuse of proven templates and components (Steps, Tabs, Cards) to standardize layout
  • Guidance on redirects, navigation, and verification using the docs workflow

Quick Start

Create or update a docs page by adding frontmatter and following the recommended structure. Then author the content using the established patterns and run through the verification checklist before publishing.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I structure frontmatter for new documentation pages?

Documentation frontmatter requires metadata fields like title, description, and keywords to ensure accessibility and discoverability. Enforcing this structure reduces drift and standardizes page layout across the docs site.

What's the best way to write consistent API docs and integration guides?

The best way to write consistent API docs and integration guides is by reusing proven content templates and components like Steps, Tabs, and Cards. These documentation patterns standardize layout and speed up publishing.

How do I update existing MDX documentation without breaking navigation?

Updating MDX documentation without breaking navigation requires applying established content patterns and verifying redirects through the docs workflow. Running through a verification checklist before publishing ensures navigation remains intact.

What documentation patterns are available for tutorials and overviews?

Available documentation patterns include structured templates for Tutorial, Overview, Reference, and Integration pages. These patterns provide standardized layouts using components like Steps and Tabs to maintain content consistency.

How do I verify docs maintenance changes before publishing?

Verify docs maintenance changes before publishing by running the content through the established verification checklist and docs workflow. This process checks frontmatter structure, content patterns, and redirects to ensure consistency.