931f17b70e
All checks were successful
ci / fast (linux) (push) Successful in 6m46s
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>
78 lines
4.2 KiB
Markdown
78 lines
4.2 KiB
Markdown
# 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](./project-overview.md) — Executive summary, tech stack, architecture pattern, current status
|
|
- [Architecture](./architecture.md) — Layer diagram, rendering pipeline, dependency graph, threading model, data flow
|
|
- [Source Tree Analysis](./source-tree-analysis.md) — Annotated directory tree, critical folders, entry points
|
|
- [Component Inventory](./component-inventory.md) — All 22 crates with key exports, display list items, CSS/JS coverage
|
|
- [Development Guide](./development-guide.md) — Prerequisites, build/run/test commands, common tasks, code style
|
|
|
|
## Existing Documentation
|
|
|
|
### Architecture & Design
|
|
- [Architecture Exploration](./browser_architecture_initial_exploration.md) — Foundational vision, design principles, subsystem overview
|
|
- [Project Structure Guide](./browser_project_structure_modularization_guide.md) — Crate layout, dependency rules, data patterns
|
|
|
|
### Testing & Conformance
|
|
- [Testing Strategy](./browser_testing_strategy_high_level_to_detailed.md) — 6-tier testing approach, sanitizers, determinism
|
|
- [JS Conformance Report](./js_conformance_report.md) — Test262 conformance results by feature area
|
|
- [JS Feature Matrix](./js_feature_matrix.md) — JavaScript feature implementation status
|
|
- [Test262 Roadmap](./test262_roadmap.md) — Gap analysis and implementation plan for Test262
|
|
- [External Conformance (WPT)](./external_conformance_wpt.md) — Web Platform Tests integration details
|
|
- [WPT Known Failures](./wpt_known_fail_analysis.md) — WPT failure analysis and tracking
|
|
|
|
### Implementation Status
|
|
- [CSS2.1 Implementation Checklist](./CSS2.1_Implementation_Checklist.md) — CSS property support status
|
|
- [HTML5 Implementation Checklist](./HTML5_Implementation_Checklist.md) — HTML element/attribute support
|
|
- [Known Limitations](./known_limitations_log.md) — Intentionally deferred items and trade-offs
|
|
|
|
### CI/CD & Infrastructure
|
|
- [Build/CI Contract](./build_ci_contract_gitea_ci_rust_monorepo.md) — CI pipeline, policy enforcement, merge blockers
|
|
|
|
### Planning
|
|
- [Milestone Plan](./browser_milestone_plan.md) — Development milestones
|
|
- [Milestone 6 Plan](./milestone_6_phased_implementation_plan.md) — Current milestone phased implementation
|
|
|
|
### Investigation Reports
|
|
- [Acid2 Investigation](../investigations/acid2/report.md)
|
|
- [Google Investigation](../investigations/google/report.md)
|
|
- [Moldybits Investigation](../investigations/moldybits/report.md)
|
|
- [Slashdot Investigation](../investigations/slashdot/report.md)
|
|
- [YouTube Investigation](../investigations/youtube/report.md)
|
|
|
|
## 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](./development-guide.md) for full setup and workflow
|
|
|
|
## For AI Agents
|
|
|
|
When working on this project, reference:
|
|
- **Architecture boundaries:** [Architecture](./architecture.md) → Layer rules and dependency graph
|
|
- **CSS changes:** [CSS2.1 Checklist](./CSS2.1_Implementation_Checklist.md) → Update after changes
|
|
- **HTML changes:** [HTML5 Checklist](./HTML5_Implementation_Checklist.md) → Update after changes
|
|
- **JS changes:** [JS Feature Matrix](./js_feature_matrix.md) → Update after changes
|
|
- **Testing requirements:** [Development Guide](./development-guide.md) → Run `just ci` after every change
|
|
- **Known limitations:** [Known Limitations](./known_limitations_log.md) → Check before implementing workarounds
|