# rfheadless — Documentation
Welcome to the rfheadless docs. This repository provides a headless browsing engine API for Rust. Use the links below for quick orientation:
- **Getting started** — Basic build and use instructions. (See `docs/getting-started.md`)
- **Development** — How to run tests, benches, and generate flamegraphs/docs. (See `docs/development.md`)
- **API** — Pages describing public API and internals (See `docs/api/engine.md`, `docs/api/types.md`, `docs/api/rfengine.md`).
- **Platform** — Platform surfaces such as Service Workers, Media hooks, Accessibility (See `docs/platform.md`).
- **Rendering** — Rendering primitives and deterministic raster helpers (See `docs/rendering.md`).
- **Examples & Benchmarks** — How to run examples and benches (See `docs/examples.md`).
- **Contributing** — Project contribution guidelines (See `docs/CONTRIBUTING.md`).
> Note: for the full API reference, run `cargo doc --open` or view docs on docs.rs once published.