Skip to content

Grumpified-OGGVCT/BrowserOS_Guides

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

193 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ BrowserOS Workflows Knowledge Base

A self-aware intelligence layer for BrowserOS agents
Self-maintaining, AI-powered, with HTTP MCP server for immediate agent integration

🌟 New: HTTP MCP Server Integration

Connect this knowledge base to BrowserOS in 30 seconds via "Add Custom App"

npm run mcp-server
# Server starts at http://localhost:3100/mcp

πŸ“– Quick Start Guide | πŸ—οΈ Architecture | πŸ“‘ MCP Integration

GitHub Actions Python Node.js License


✨ What's New in v2.0

This repository has evolved into an operational intelligence layer for BrowserOS agents:

  • 🧠 HTTP MCP Server - 10 tools for agent self-awareness
  • 🎯 917+ Claude Skills - Daily auto-extracted from awesome-claude-skills
  • πŸ“š 917+ Executable Workflows - Ready-to-use, validated templates
  • πŸ” Content Integrity - SHA-256 hashing with delta detection
  • ⚠️ Anti-Patterns Catalog - Know what fails before trying
  • βœ… Ground Truth Validation - Verified against BrowserOS source code
  • πŸ”„ Event-Driven Updates - Real-time sync with BrowserOS repo
  • 🌐 Universal MCP - Works with BrowserOS, Claude Desktop, Cursor, etc.

🎯 NEW: 917+ Claude Skills Library

Daily automated extraction from awesome-claude-skills!

Every day at 2:00 AM UTC, our GitHub Actions workflow automatically:

  • βœ… Clones/updates the awesome-claude-skills repository
  • βœ… Extracts browser-compatible skills (web automation, scraping, form filling, etc.)
  • βœ… Adapts them to BrowserOS workflow format
  • βœ… Runs security scanning and sanitization
  • βœ… Updates the search index and commits changes

πŸ™ Huge credit to Composio HQ and the awesome-claude-skills contributors!

πŸ“‚ Browse all skills: BrowserOS/Workflows/Community-Contributed/claude-skills-adapted/
🌐 View online: Skills Library Section

How to Use

Option 1: MCP Server (Recommended for BrowserOS)

npm run mcp-server
# Add to BrowserOS: http://localhost:3100/sse

Option 2: Interactive Website

# Open docs/index.html or deploy to GitHub Pages

Option 3: Direct Library Import

import templates from './library/templates'

🌐 Live Website (Setup Required)

Interactive knowledge hub with 917+ workflows, 500+ use cases, and AI-powered tools

⚠️ GitHub Pages Setup Required: To make the live site available at https://grumpified-oggvct.github.io/BrowserOS_Guides/, you need to:

  1. Merge this PR to main/master branch
  2. Enable GitHub Pages: Go to Settings β†’ Pages β†’ Source: "GitHub Actions"
  3. The deployment workflow will automatically publish the site

πŸ“Έ Website Preview

Interactive Knowledge Hub

BrowserOS Knowledge Hub homepage showing hero section with 917+ workflows, 500+ use cases, and AI-powered tools

The static website in docs/ includes the full interactive knowledge hub with 917+ workflows and 500+ use cases


πŸ™ Acknowledgments & Credit

BrowserOS Team - The Amazing Builders! 🌟

This repository exists to document and celebrate the incredible work of the BrowserOS team who built this groundbreaking browser automation platform.

πŸŽ‰ HUGE CREDIT to the BrowserOS team for:

  • πŸ—οΈ Building an innovative browser automation platform
  • πŸ“š Creating comprehensive workflow capabilities
  • πŸ€– Enabling AI-powered web interactions
  • 🌐 Open-sourcing their amazing work
  • πŸ’‘ Pioneering the future of browser-based automation

Official BrowserOS Resources:

This knowledge base is a community contribution that aggregates and organizes information about BrowserOS Workflows to help developers learn and build with this powerful platform.


πŸ“– What Is This Repository?

This is a living, self-maintaining knowledge base that:

βœ… Automatically researches BrowserOS Workflows from multiple sources
βœ… Uses AI (Ollama + OpenRouter) to synthesize information intelligently
βœ… Updates weekly with the latest features, patterns, and best practices
βœ… Self-validates to ensure completeness and accuracy
βœ… Tracks changes with version tagging (kb-YYYY.MM.DD)

The Problem We're Solving

Challenge: Keeping up with BrowserOS's rapid development
Solution: Automated AI-powered knowledge compilation from official sources


🎨 Website Features (in docs/ Directory)

πŸ“š 130+ Workflows Organized by Category

Workflows section displaying 130+ organized workflows across E-Commerce, Data Extraction, Testing, QA, Social Media, Research, CRM, Content Creation, and API Integration categories

E-Commerce, Data Extraction, Testing & QA, Social Media, Research, CRM, Content Creation, API Integration, and more!

🎯 500+ Use Cases Across Industries

Use cases section showing 500+ real-world examples across retail, healthcare, finance, logistics, marketing, and customer service industries

Real-world examples from retail, healthcare, finance, logistics, marketing, customer service, and beyond

πŸ€– MCP & Agentic AI Integration

MCP and Agentic AI integration guide showing compatibility with VSCode, Cursor, Windsurf, Claude Desktop, MSTY, AnythingLLM, and 10+ other AI development tools

Use BrowserOS with VSCode, Cursor, Windsurf, Claude Desktop, MSTY, AnythingLLM, and 10+ AI tools

πŸ“‚ Interactive Repository Browser

Interactive repository browser interface showing file tree navigation, search functionality, and content preview capabilities

Browse the entire repository structure, search files, preview content, and navigate with ease

πŸ” Powerful Search Functionality

Search interface with AI-powered search capabilities across 500+ use cases, 130+ workflows, and comprehensive documentation

AI-powered search across 500+ use cases, 130+ workflows, and comprehensive documentation


🎯 Why This Exists

Use Cases

1. For Developers Building with BrowserOS

  • πŸ“š Comprehensive reference for all workflow capabilities
  • πŸ” Searchable documentation of 14+ step types
  • πŸ’‘ Real-world patterns and examples
  • ⚑ Always up-to-date with latest features

2. For Teams Evaluating BrowserOS

  • πŸ“Š Complete capability overview
  • πŸ”’ Security and compliance information
  • πŸ’° Resource limits and constraints
  • 🏒 Enterprise features documentation

3. For AI Agents & LLM Context

  • πŸ€– Structured knowledge base for RAG systems
  • πŸ“ Complete schema definitions
  • πŸ”— Cross-referenced information
  • βœ… Validated and fact-checked content

4. For Learning & Onboarding

  • πŸŽ“ Step-by-step workflow creation guides
  • 🎯 Best practices and patterns
  • πŸ” Security guidelines
  • πŸ“ˆ Migration paths and version history

πŸ€– How It Works - The Automation Magic

Weekly Automated Updates (GitHub Actions)

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ πŸ• SUNDAY 00:00 UTC - Automated Research Begins         β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ 1️⃣  CLONE OFFICIAL REPOS                                β”‚
β”‚    β€’ browseros-ai/BrowserOS (latest)                    β”‚
β”‚    β€’ browser-use/workflow-use                           β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ 2️⃣  FETCH WEB SOURCES                                   β”‚
β”‚    β€’ Documentation sites                                 β”‚
β”‚    β€’ GitHub issues & PRs                                 β”‚
β”‚    β€’ Community discussions                               β”‚
β”‚    β€’ Technical specifications                            β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ 3️⃣  AI-POWERED ANALYSIS                                 β”‚
β”‚    🧠 Ollama API: Local LLM processing                  β”‚
β”‚    πŸ€– OpenRouter: Claude/GPT-4 synthesis                β”‚
β”‚    β†’ Extract insights, changes, patterns                β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ 4️⃣  SYNTHESIZE & UPDATE KB                              β”‚
β”‚    β€’ Generate "Latest Updates" section                   β”‚
β”‚    β€’ Add new features discovered                         β”‚
β”‚    β€’ Update examples and patterns                        β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ 5️⃣  VALIDATE COMPLETENESS                               β”‚
β”‚    βœ… All 12 sections present (C01)                     β”‚
β”‚    βœ… No placeholders (C02)                             β”‚
β”‚    βœ… Valid sources (C03)                               β”‚
β”‚    βœ… Checksum tracking (C05)                           β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ 6️⃣  AUTO-COMMIT & TAG                                   β”‚
β”‚    πŸ“ Commit: "πŸ€– Automated KB update - YYYY-MM-DD"     β”‚
β”‚    🏷️  Tag: kb-YYYY.MM.DD                               β”‚
β”‚    πŸš€ Push to main branch                               β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Powered By

  • πŸ€– Ollama Cloud Service - Local LLM processing for analysis
  • 🧠 OpenRouter - Access to Claude, GPT-4, and other frontier models
  • ⚑ GitHub Actions - Automated weekly execution
  • 🐍 Python - Research pipeline and validation scripts

πŸ“š What's Inside the Knowledge Base?

Comprehensive Coverage (12 Major Sections)

  1. πŸ“‹ Overview & Scope - What BrowserOS Workflows can do
  2. πŸ—οΈ Architecture Diagram - Visual system architecture
  3. πŸ”§ Step Types Catalog - All 14+ step types with examples
  4. πŸ”„ Execution Flow Control - Loops, branching, parallel execution
  5. 🎯 Trigger & Integration Matrix - How workflows start and connect
  6. πŸ“ Configuration Schema - Complete JSON Schema reference
  7. πŸš€ Advanced Features - CodeAgent, Cowork, enterprise capabilities
  8. ⚠️ Limitations & Constraints - Resource limits, performance
  9. πŸ”’ Security Best Practices - Secrets, validation, XSS prevention
  10. πŸ’‘ Community Patterns - Real-world use cases and examples
  11. πŸ“ˆ Migration & Version History - Upgrade paths and changelogs
  12. πŸ“– Appendices - Glossary, acronyms, FAQ, license

Key Capabilities Documented

Workflow Step Types (14+)

  • navigate - URL navigation
  • click - Element interaction
  • input - Form filling
  • extract - Data scraping
  • wait - Conditional pausing
  • conditional - If/then/else logic
  • loop - Iteration (foreach, while, repeat)
  • parallel - Concurrent execution
  • screenshot - Page capture
  • execute_code - Python CodeAgent
  • read_file / write_file - Cowork integration
  • shell - Command execution
  • api_call - HTTP requests
  • sub_workflow - Workflow composition

Advanced Features

  • 🐍 Python CodeAgent - Execute Python in workflows (pandas, numpy, requests)
  • πŸ“ Cowork Integration - Local file system access
  • πŸ”„ Self-Healing - AI-powered element detection on failure
  • ⚑ Parallel Execution - Multiple operations simultaneously
  • πŸ” Secrets Management - Secure API key handling
  • πŸŽ›οΈ Lifecycle Hooks - Custom logic at workflow boundaries

πŸš€ Quick Start

🌍 Cross-Platform Installation (Windows, macOS, Linux)

Universal installation system with auto-update:

πŸͺŸ Windows

git clone https://github.com/Grumpified-OGGVCT/BrowserOS_Guides.git
cd BrowserOS_Guides
install.bat          # Install dependencies & launch wizard
run.bat              # Run the system

🍎 macOS / 🐧 Linux

git clone https://github.com/Grumpified-OGGVCT/BrowserOS_Guides.git
cd BrowserOS_Guides
chmod +x install.sh run.sh
./install.sh         # Install dependencies & launch wizard
./run.sh             # Run the system

Features:

  • βœ… Universal Installation - Works on Windows, macOS, Linux
  • βœ… Interactive Setup Wizard - Guides through ALL configuration
  • βœ… Auto-Update System - Checks and installs updates on startup (bulletproof!)
  • βœ… Configuration Manager - Modify settings anytime
  • βœ… Main Menu - All operations in one place
  • βœ… Cross-Platform - Same functionality everywhere

πŸ“– Guides:


🌐 View the Interactive Website

The website exists in the docs/ directory and can be viewed:

Option 1: View Locally (Works Now)

# Clone the repository
git clone https://github.com/Grumpified-OGGVCT/BrowserOS_Guides.git
cd BrowserOS_Guides

# Start a local web server
python3 -m http.server 8000 --directory docs

# Open in browser: http://localhost:8000

Option 2: Via GitHub Pages (Requires Setup)

To enable the live GitHub Pages site at https://grumpified-oggvct.github.io/BrowserOS_Guides/:

  1. Merge this PR to main/master branch
  2. Enable GitHub Pages:
    • Go to: Settings β†’ Pages
    • Source: Select "GitHub Actions"
    • Save
  3. Deployment is automatic - The workflow in .github/workflows/deploy-pages.yml will deploy on every push to main

πŸ“– Access the Knowledge Base Content

Three ways to explore:

  1. πŸ“‚ Interactive Website (in docs/ folder)

    • Full website with navigation
    • Real-time search
    • Repository browser
    • View locally or deploy to GitHub Pages
  2. πŸ“‚ Repository Browser: Open docs/repo-browser.html locally

    • Navigate folder structure
    • Search across all files
    • Preview markdown content
  3. πŸ“„ Direct KB: BrowserOS/Research/BrowserOS_Workflows_KnowledgeBase.md

    • Complete knowledge base markdown
    • Downloadable for offline use

For Maintainers: Enable Automation

1. Add API Keys (GitHub Secrets)

Settings β†’ Secrets and variables β†’ Actions β†’ New repository secret

Secret Name Where to Get It Purpose
OLLAMA_API_KEY https://ollama.ai/keys LLM processing
OPENROUTER_API_KEY https://openrouter.ai/keys Enhanced AI research

2. Enable GitHub Actions

  • Settings β†’ Actions β†’ General
  • Workflow permissions: "Read and write"
  • βœ… Allow GitHub Actions to create and approve pull requests

3. Test It!

  • Go to Actions tab
  • Select "Update BrowserOS Knowledge Base"
  • Click "Run workflow"
  • Monitor progress and verify results

πŸ“– Detailed Setup: AUTOMATION_QUICKSTART.md (5-minute guide)


πŸ“ Repository Structure

BrowserOS_Guides/
β”‚
β”œβ”€β”€ πŸ“– README.md (this file)
β”œβ”€β”€ πŸš€ AUTOMATION_QUICKSTART.md       # 5-minute setup guide
β”œβ”€β”€ πŸ“‹ LICENSE                         # MIT License
β”‚
β”œβ”€β”€ πŸ—‚οΈ BrowserOS/                     # Knowledge Base Directory
β”‚   β”œβ”€β”€ structure.md                   # Primary index
β”‚   β”œβ”€β”€ README.md                      # KB usage guide
β”‚   └── Research/
β”‚       β”œβ”€β”€ BrowserOS_Workflows_KnowledgeBase.md (⭐ MAIN KB)
β”‚       β”œβ”€β”€ sources.json               # 12 research sources
β”‚       β”œβ”€β”€ verify_kb_completeness.ps1 # PowerShell validation
β”‚       └── raw/                       # Archived sources (gitignored)
β”‚
β”œβ”€β”€ βš™οΈ .github/
β”‚   β”œβ”€β”€ workflows/
β”‚   β”‚   └── update-kb.yml              # GitHub Actions automation
β”‚   └── ACTIONS_SETUP.md               # Detailed automation docs
β”‚
β”œβ”€β”€ 🐍 scripts/
β”‚   β”œβ”€β”€ research_pipeline.py           # AI-powered research engine
β”‚   β”œβ”€β”€ validate_kb.py                 # KB validation (C01-C05)
β”‚   β”œβ”€β”€ setup_wizard.py                # Interactive first-run configuration (cross-platform)
β”‚   β”œβ”€β”€ config_manager.py              # Post-setup configuration tool (cross-platform)
β”‚   β”œβ”€β”€ auto_update.py                 # Bulletproof auto-update system (cross-platform)
β”‚   β”œβ”€β”€ workflow_generator.py          # AI-powered workflow creation
β”‚   β”œβ”€β”€ self_test.py                   # Comprehensive system tests
β”‚   └── security_scanner.py            # Security vulnerability scanner
β”‚
β”œβ”€β”€ πŸͺŸ install.bat                     # Windows installation script
β”œβ”€β”€ πŸͺŸ run.bat                         # Windows main execution menu
β”œβ”€β”€ 🐧 install.sh                      # Unix installation script (macOS/Linux)
β”œβ”€β”€ 🐧 run.sh                          # Unix main execution menu (macOS/Linux)
β”œβ”€β”€ πŸ“¦ requirements.txt                # Python dependencies
β”œβ”€β”€ πŸ”§ config.yml                      # Universal configuration
β”œβ”€β”€ πŸ“ .env.template                   # Environment variables template
β”œβ”€β”€ πŸ”§ update_kb.ps1                   # PowerShell automation script
└── πŸ™ˆ .gitignore                      # Comprehensive exclusions

πŸ§ͺ Local Development & Testing

Prerequisites

# Python 3.11+ required
python --version

# Install dependencies
pip install -r requirements.txt

Test Validation

# Run KB validation (C01-C05 checks)
python scripts/validate_kb.py

Test Research Pipeline

# Set API keys
export OLLAMA_API_KEY="your-ollama-key"
export OPENROUTER_API_KEY="your-openrouter-key"

# Run research pipeline
python scripts/research_pipeline.py

PowerShell Automation (Windows)

# Dry run (no commits)
.\update_kb.ps1 -DryRun

# Full update
.\update_kb.ps1

πŸ’° Cost & Sustainability

API Costs (Estimated)

Weekly automated runs:

  • Ollama API: ~2K-4K tokens/run = $1-5/month
  • OpenRouter API: ~4K tokens/run = $0.50-2/month

Total: ~$1.50-7/month for fully automated, always-current KB

This is far cheaper than manual documentation maintenance and ensures the KB is always up-to-date with BrowserOS's rapid development.


🎯 Validation & Quality Assurance

Every KB update must pass 6 validation checks:

  • βœ… C01: All 12 required sections present
  • βœ… C02: No placeholder markers (TODO, TBD, FIXME)
  • βœ… C03: Valid sources.json with complete metadata
  • βœ… C04: YAML/JSON schema validation
  • βœ… C05: Checksum stability tracking
  • βœ… C06: Git repository cleanliness and proper tagging

🀝 Contributing

We welcome contributions to improve the knowledge base!

How to Contribute

  1. Improve Documentation

    • Add new examples
    • Clarify existing content
    • Fix inaccuracies
  2. Enhance Automation

    • Improve AI prompts
    • Add new sources to sources.json
    • Optimize research pipeline
  3. Report Issues

    • Documentation gaps
    • Automation failures
    • Validation errors

Contribution Process

  1. Fork the repository
  2. Create a feature branch
  3. Test your changes locally
  4. Submit a PR with clear description
  5. Pass validation checks

πŸ“… Update Schedule

  • πŸ€– Automated: Every Sunday at 00:00 UTC
  • πŸ‘€ Manual: Via GitHub Actions UI (workflow_dispatch)
  • 🏷️ Versioning: Tagged as kb-YYYY.MM.DD

Next scheduled update: Check the Actions tab for countdown


πŸ”— Official BrowserOS Resources

Primary Sources

This Repository's Resources

  • πŸ“‚ Interactive Website: Available in docs/ directory (view locally or deploy to GitHub Pages)
  • πŸ“‚ Repository Browser: docs/repo-browser.html (view locally)
  • πŸ’» GitHub Repo: github.com/Grumpified-OGGVCT/BrowserOS_Guides

Community


❓ FAQ

Q: How do I view the interactive website?

A: The website files are in the docs/ directory. You can:

  • View locally now: Run python3 -m http.server 8000 --directory docs and open http://localhost:8000
  • Deploy to GitHub Pages: Merge this PR, then enable GitHub Pages in Settings β†’ Pages β†’ Source: "GitHub Actions"

The website includes searchable workflows, use cases, repository browser, and comprehensive documentation.

Q: Why isn't the GitHub Pages link working?

A: GitHub Pages requires setup:

  1. This PR needs to be merged to main branch
  2. GitHub Pages needs to be enabled in repository settings (Settings β†’ Pages β†’ Source: "GitHub Actions")
  3. Once enabled, the deployment workflow will automatically publish the site at https://grumpified-oggvct.github.io/BrowserOS_Guides/

Q: Why automate this?

A: BrowserOS is rapidly evolving. Automated compilation ensures the KB stays current without manual effort, capturing new features as they're released.

Q: Why use AI?

A: AI (Ollama + OpenRouter) intelligently synthesizes information from multiple sources, identifies patterns, and presents insights in a structured format.

Q: Is this official documentation?

A: No, this is a community-maintained knowledge base. Always refer to official BrowserOS docs for authoritative information. We aggregate and organize that information for easier consumption.

Q: Can I contribute?

A: Absolutely! See the Contributing section above. We welcome improvements, examples, and corrections.

Q: How accurate is the KB?

A: We use official sources and validate all updates (C01-C06 checks). However, always verify critical information with official docs.

Q: What if APIs fail?

A: The system gracefully degrades - it can still fetch and archive sources without AI synthesis. Manual review can then be performed.


πŸ“œ License

MIT License - See LICENSE file

This repository is independently maintained and is not officially affiliated with BrowserOS. We're just huge fans documenting their amazing work! πŸŽ‰


🌟 Star History

If this knowledge base helps you, please star the repo! ⭐

It helps others discover this resource and shows appreciation for the automation work.


πŸ”„ Workflow Automation Status

This repository uses GitHub Actions to automate maintenance and updates:

Workflow Status Purpose Trigger
πŸ“š Update KB ⚑ Ready Syncs with official BrowserOS repo, generates workflows Weekly Sun 00:00 UTC + Manual
πŸ§ͺ Self-Test ⚑ Ready Runs 42 tests, security scans, auto-fixes issues Weekly Sun 02:00 UTC + Manual
πŸš€ Deploy Pages βœ… Active Deploys website to GitHub Pages On push + Manual
🎯 Trigger All ⚑ Ready Convenience workflow to trigger others Manual only

Quick Actions:

For Detailed Workflow Information:


πŸ“ž Support & Contact


Built with ❀️ by the community
Celebrating the incredible work of the BrowserOS team πŸŽ‰

πŸ“‚ Interactive Website in docs/ Directory

View locally: python3 -m http.server 8000 --directory docs
Deploy to Pages: Merge PR + enable in Settings β†’ Pages

⭐ Star this repo β€’ πŸ”€ Fork it β€’ πŸ“– Read the KB

About

A localized workflow to find, compile and save online guides for BrowserOS for use in local agents as knowledge bases

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors