Files
rust_browser/docs/index.md
Zachary D. Rowitsch 931f17b70e
All checks were successful
ci / fast (linux) (push) Successful in 6m46s
Add BMAD framework, planning artifacts, and architecture decision document
Install BMAD workflow framework with agent commands and templates.
Create product brief, PRD, project context, and architecture decision
document covering networking/persistence strategy, JS engine evolution
path, threading model, web_api scaling, system integration, and
tab/process model. Add generated project documentation (architecture
overview, component inventory, development guide, source tree analysis).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-12 15:13:06 -04:00

4.2 KiB

rust_browser — Documentation Index

Generated: 2026-03-05 | Scan Level: Deep | Workflow: document-project v1.2.0

Project Overview

  • Type: Monolith (Cargo workspace, 22 crates)
  • Primary Language: Rust (edition 2021, stable toolchain)
  • Architecture: Layered pipeline (4 layers, strict downward dependencies)
  • Project Category: Desktop Application — Web Browser Engine

Quick Reference

  • Tech Stack: Rust + winit + softbuffer + custom JS engine + custom HTML/CSS parsers
  • Entry Point: crates/app_browser/src/main.rs
  • Architecture Pattern: Layered pipeline with arena-based data flow
  • Build: cargo build -p app_browser
  • Test: just ci (full pipeline ~1 min)
  • Run: cargo run -p app_browser -- <URL>

Generated Documentation

  • Project Overview — Executive summary, tech stack, architecture pattern, current status
  • Architecture — Layer diagram, rendering pipeline, dependency graph, threading model, data flow
  • Source Tree Analysis — Annotated directory tree, critical folders, entry points
  • Component Inventory — All 22 crates with key exports, display list items, CSS/JS coverage
  • Development Guide — Prerequisites, build/run/test commands, common tasks, code style

Existing Documentation

Architecture & Design

Testing & Conformance

Implementation Status

CI/CD & Infrastructure

Planning

Investigation Reports

Getting Started

  1. Install Rust (stable) and just
  2. cargo build -p app_browser
  3. cargo run -p app_browser -- https://example.com
  4. See Development Guide for full setup and workflow

For AI Agents

When working on this project, reference: