Skip to content

Docs on GitHub

The repository has the full technical documentation:

Document Covers
README Overview, install options, platform matrix
docs/USAGE.md Operations, MCP usage, tracing, HA mesh
docs/PROTOCOL.md Hub ↔ worker wire protocol
docs/INTERNALS.md Go concurrency and systems internals
docs/ADAPTERS.md Writing a site adapter
docs/COMPARISON.md Trade-offs against Firecrawl, Crawl4AI and Jina Reader
docs/LAUNCH-FAQ.md Common questions, honest limits
SECURITY.md Threat model and reporting
CONTRIBUTING.md How to contribute, test rules
bench/RESULTS.md Token benchmark on an 8-fixture synthetic corpus

Go package documentation is on pkg.go.dev.