write-docs

Generates Mintlify MDX documentation for BrowserOS features by analyzing the codebase.

13.1k|1.4k|Updated May 18, 2025
One-click install
npx skills add https://github.com/browseros-ai/BrowserOS --skill write-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/browseros-ai/BrowserOS/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/browseros-ai/BrowserOS --skill write-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write clear, concise feature documentation for BrowserOS by analyzing the codebase and generating Mintlify MDX pages.

Core Features & Use Cases

  • Codebase analysis: Inspects the BrowserOS features in ../browseros-server to understand behavior and usage.
  • Documentation generation: Produces MDX docs suitable for Mintlify, including structure, headings, and navigation notes.
  • Documentation updates: Updates or creates docs pages and config to reflect new features.

Quick Start

Run the skill to generate docs for a feature by providing the feature name, then place the resulting MDX file in docs/features/.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I auto-generate Mintlify MDX documentation from a codebase?

To auto-generate Mintlify MDX documentation, this skill inspects feature code in ../browseros-server, analyzes behavior and usage, and outputs concise one-page MDX files ready for the docs directory. It reads feature code directly to produce structured documentation with headings and navigation notes.

What is the process for updating docs.json navigation when adding new feature docs?

Updating docs.json navigation involves generating a new MDX page for the feature and adding corresponding navigation notes to the configuration. This skill produces both the MDX content for docs/features/ and the necessary navigation updates for docs.json to reflect the new page.

Do I need to access the browseros-server repository to generate feature docs?

Yes, you need access to the browseros-server repository to generate feature docs. The skill requires reading feature code from ../browseros-server to understand behavior, gather requirements, and produce accurate MDX documentation that reflects the actual implementation.

Can I use this to write documentation for any feature in my repository?

This skill generates documentation specifically for BrowserOS features by analyzing the ../browseros-server codebase. It is designed for feature documentation tasks across the repository, producing Mintlify MDX pages tailored to the BrowserOS documentation structure and conventions.

What's the best way to create one-page readable docs for BrowserOS features?

The best way to create one-page readable docs is to run this skill with a feature name, which analyzes the codebase and generates a concise Mintlify MDX file. Place the resulting file in docs/features/ to ensure it integrates cleanly with the existing documentation site.