Boring Doc

Official docs are the source of truth but slow to use. Boring Doc keeps a synced index of the Flutter docs, release notes and API, and turns it into 30-second explanations, real version-to-version comparisons and a cited “what changed”.

An interactive documentation platform that sits on top of the official Flutter documentation instead of copying it. Every topic opens with a one-sentence answer, then key points, an interactive visual, an analogy (with where it breaks), working code, common mistakes and the exact official sources it was checked against.

An idempotent ingestion pipeline watches the official repositories and feeds, so you can compare any two real stable releases and see every indexed change — categorised, sorted by impact, with migration guides and evidence. AI explanations are optional, provider-independent and grounded in retrieved sources; everything works with AI switched off.

The problem

Official docs are long and change every few weeks. Finding one answer means scrolling a 5,000-word page; “what changed between my version and the latest?” means reading dozens of release notes by hand; and chatbots answer with confident, made-up APIs.

The approach

An intelligent layer over the docs: authored explanations verified against a specific version, a change index built automatically from the official sources, and AI that cites those sources or says “insufficient evidence”.

What it includes

• Learn in 30 secondsThirteen Flutter topics with the same nine sections: quick answer, key points, visual, analogy, code, when to use, mistakes, related, sources.
• Version Comparison StudioAny two real stable releases; changes by category and impact, migration guides, before/after diffs and an optional verified GitHub source diff.
• What’s new & Explore changesThe latest stable series grouped by category; URL-driven filters by impact, evidence, platform and release.
• Search and command paletteConcepts, guides, API symbols and changes in one search (Ctrl/Cmd+K), with typo tolerance.
• Automatic sync with provenanceWebhook + daily cron ingestion; every record keeps its source commit and “last synchronized” time.
• Grounded AI (optional)Explain, generate an example, migration assistant — cites sources inline; works with local or hosted models.
• Review queueLow-confidence, high-impact items wait for a human before publishing.
• More ecosystemsPlannedReact Native, Android, Jetpack Compose, Swift, React and Next.js via adapters.

Role

• Sole developer: product, ingestion pipeline, data model, UI and visual design, tests and deployment.

How it is put together

1. Source adaptersGitHub, release feeds, API index
2. Ingestion pipelineIdempotent, incremental, validated
3. PostgreSQLPGlite or managed; search index
4. Read modelsComparison engine, queries
5. Next.js UI + grounded AITopics, compare, what’s new

• HTTPS host allowlist for outbound requests
• HMAC-verified webhooks
• Sanitised Markdown
• Conservative publishing policy

Simplified. Jobs are keyed by source + revision, so overlapping triggers never duplicate records.

Reported outcomes

• 3,679indexed Flutter changesSource: Live site, 22 Oct 2026
• 180stable releases trackedSource: Live site, 22 Oct 2026
• 4,624API symbols searchableSource: Live site, 22 Oct 2026
• 67unit tests, plus Playwright journeysSource: README