Productivity
write-docs avatar

write-docs

Automate the creation and maintenance of BrowserOS feature documentation using a structured, codebase-aware workflow to generate concise Mintlify MDX pages.

Introduction

The write-docs skill is a specialized utility for developers and technical writers to maintain high-quality, up-to-date documentation for the BrowserOS ecosystem. By analyzing the BrowserOS codebase—specifically the server components in the sibling directory—this skill ensures that feature documentation accurately reflects current implementations. It simplifies the technical documentation lifecycle, transitioning from feature discovery and code analysis to the generation of standardized, reader-friendly MDX files ready for the Mintlify-based documentation platform.

  • Automated Codebase Exploration: Uses Grep and Glob tools to navigate relevant feature directories, extracting functional requirements and core mechanics directly from source code.

  • Structured MDX Generation: Produces consistent, professional documentation following a predefined schema, including title, description, 'How It Works', and 'Getting Started' sections.

  • Integrated Screenshot Workflow: Simplifies the inclusion of visual aids by providing a standardized process to capture and save UI elements directly into the project's asset directory.

  • Navigation Synchronization: Automatically manages the documentation structure by updating docs.json, ensuring new content is correctly categorized within the site's navigation hierarchy.

  • Practical, No-Fluff Style: Enforces a style guide that prioritizes user-facing instructions and practical use cases over internal implementation details, ensuring documentation remains concise and actionable.

  • Targeted primarily for BrowserOS features such as the MCP server, scheduled tasks, and automation workflows.

  • Requires local development environment access to the codebase for accurate scanning.

  • Recommended usage involves interactive prompts where the user specifies the feature, followed by the skill's request for supporting screenshots.

  • Keeps documents to a maximum length of one page to maintain high clarity for first-time users.

  • Designed for seamless integration with the existing BrowserOS documentation workflow, including support for local preview via mint dev commands.

Repository Stats

Stars
10,719
Forks
1,064
Open Issues
83
Language
TypeScript
Default Branch
main
Sync Status
Idle
Last Synced
Apr 30, 2026, 04:31 PM
View on GitHub