docs-writer

Create and validate Mintlify MDX documentation for Bifrost features.

7.2k|1.0k|Updated Mar 19, 2025
One-click install
npx skills add https://github.com/maximhq/bifrost --skill docs-writer-maximhq
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/maximhq/bifrost/tree/main/.claude/skills/docs-writer
Command: npx skills add https://github.com/maximhq/bifrost --skill docs-writer-maximhq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writes, updates, and reviews Mintlify MDX documentation for Bifrost features. It explores the full codebase (UI, Go backend, config schema), validates config.json examples against the schema, places screenshot placeholders, and presents outlines for approval before writing.

Core Features & Use Cases

  • Research the codebase across the Next.js UI and Go backend to understand feature scope and usage.
  • Validate config.json examples against transports/config.schema.json, ensuring fields, types, and enums are correct.
  • Generate structured doc outlines, write MDX content, and prepare navigation updates for docs.json.
  • Produce screenshot placeholders and guide reviewers through an approval workflow before publishing.

Quick Start

Invoke the skill by saying /docs-writer <feature-name> to generate new docs.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I generate Mintlify MDX documentation for new features?

To generate Mintlify MDX documentation for new features, you can automate the process by researching the codebase across the Next.js UI and Go backend to understand feature scope. The workflow produces structured outlines, writes MDX content, and prepares navigation updates for docs.json.

What's the best way to validate config.json examples against a schema for docs?

Validating config.json examples for documentation involves checking fields, types, and enums against transports/config.schema.json. This ensures configuration examples in your MDX files are correct and align with the project's schema validation rules before publishing.

Can I automate updating docs.json navigation when adding new MDX pages?

Yes, you can automate updating docs.json navigation when adding new MDX pages. The documentation workflow generates structured doc outlines and automatically prepares the corresponding navigation updates required for Mintlify.

How do I research a Go backend and Next.js UI to write technical docs?

Researching a Go backend and Next.js UI to write technical docs involves exploring the full codebase to understand feature scope and usage. This ensures generated content accurately reflects the implementation and configuration schema.

Does this docs workflow support adding screenshot placeholders before publishing?

Yes, this docs workflow supports adding screenshot placeholders before publishing. It places placeholders within the generated MDX content and guides reviewers through an approval workflow to ensure accurate visual context before final publication.