bifrost-documentation

Refresh gobifrost documentation with screenshots, MDX pages, and pull requests.

55|14|Updated Oct 12, 2025
One-click install
npx skills add https://github.com/gobifrost/bifrost --skill bifrost-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bifrost-documentation
Source: https://github.com/gobifrost/bifrost/tree/main/.claude/skills/bifrost-documentation
Command: npx skills add https://github.com/gobifrost/bifrost --skill bifrost-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the tedious, error-prone manual work of keeping the gobifrost documentation site in sync with the Bifrost integration platform, including capturing up-to-date screenshots for UI changes and authoring missing documentation pages for new features, ensuring users always have accurate, current product guidance.

Core Features & Use Cases

  • Automated Screenshot Refresh: Re-captures screenshots for existing documentation entries only when the underlying Bifrost source code changes, using pixel diffing to avoid unnecessary commits for unchanged UI.
  • Diátaxis-Aligned Page Authoring: Automatically generates properly structured MDX documentation pages for undocumented Bifrost routes, following Diátaxis quadrant rules for tutorials, how-tos, reference, and explanation content.
  • End-to-End Docs Pipeline: Orchestrates the full workflow from discovering changed and undocumented UI surface, to capturing screenshots in a headless test environment, to linting, building, and opening a pull request with a summary of all changes. Use case: Engineering teams maintaining the gobifrost documentation alongside Bifrost platform releases can use this Skill to automate the entire docs update process, eliminating the need to manually track UI changes, capture screenshots, or write new docs pages for new features.

Quick Start

Invoke the bifrost-documentation skill with no arguments to automatically bring the gobifrost documentation fully up to date with all new Bifrost features and UI changes since the last documented commit.

Frequently Asked Questions about bifrost-documentation

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

FAQPage Schema
How do I automate documentation updates for new platform UI changes?

Automating documentation updates for UI changes involves detecting modified source code, re-capturing screenshots via pixel diffing, and generating new MDX pages. This Skill orchestrates that entire workflow end-to-end, including linting, building, and opening a pull request.

How does Diátaxis documentation structure work for authoring missing pages?

Diátaxis documentation structure categorizes content into tutorials, how-tos, reference, and explanation quadrants. This Skill automatically generates missing MDX pages for undocumented routes by aligning the content with these specific Diátaxis quadrant rules.

What is the best way to keep screenshots in sync with code changes without manual overhead?

Keeping screenshots in sync with code changes is best handled by automated pixel diffing in a headless test environment. This Skill captures up-to-date screenshots only when the underlying source code changes, avoiding unnecessary commits for unchanged UI.

Can I automate the full docs pipeline from screenshot capture to PR creation?

Automating the full docs pipeline from screenshot capture to PR creation is fully supported. The Skill orchestrates discovering changed UI surfaces, capturing screenshots, linting, building, and opening a pull request with a complete summary of all changes.

Do I need to manually trigger documentation refreshes for every new Bifrost route?

Manual trigger for documentation refreshes is not needed for new Bifrost routes. You can invoke the Skill with no arguments to automatically discover undocumented UI surfaces and bring the gobifrost documentation fully up to date.

Why does automated screenshot capture use pixel diffing for documentation updates?

Automated screenshot capture uses pixel diffing to compare existing documentation entries against new UI renders. This ensures screenshots are only re-captured and committed when the underlying Bifrost source code actually changes, eliminating redundant updates.