docs: write Webview Bundle documentation (Guide / References / Config)

Merged
SE
4mo ago
+8955-1687

Summary

Restructures content/docs/ into three Fumadocs top-header tabs — Guide / References / Config — and writes 24 developer-facing English pages. All content was ground-truthed against the actual product source (webview-bundle, webview-bundle-android, webview-bundle-ios).

Structure

TabPages
GuideIntroduction (Overview, Platform Support, Why Webview Bundle) · Features (bundle format, sources, protocol handling, remote bundles, platform integration) · Platforms (Electron, Tauri, Android, iOS, Deno Desktop) · CLI (commands, programmatic API) · Remote (building a remote, Local/AWS/Cloudflare providers)
ReferencesOverview · Rust (docs.rs, external) · Node API · Deno API
ConfigThe wvb.config file · Remote / integrity / signature config

New coverage the previous draft lacked: the @wvb/bridge "for web developers" story, Deno Desktop, the three-role provider model (@wvb/remote-* / -provider / -provider-pulumi), Node & Deno API references, and rewritten Android/iOS guides using the real webview-bundle-android / -ios packages.

Wiring

  • Tabs render in the top header via root: true folder meta.json + tabMode="top" in src/routes/docs/$.tsx.
  • /docs 307-redirects to /docs/guide (src/routes/docs/index.tsx + splat loader).
  • Home "Reference" nav link repointed from the removed /docs/cli to /docs/references.

Accuracy corrections

The previous draft (and in places the upstream rustdoc) were wrong on:

  • Integrity is SHA-2 (sha256/sha384/sha512), not SHA-3
  • Pack config field is outFile (no outFileName/--outdir)
  • wvb upload --deploy defaults to false; version is the --version,-V flag, not a positional
  • iOS 16 minimum; Android/iOS bindings are functional but pre-release (not on Maven Central / no SPM tag)
  • Deno Desktop is experimental; Tauri ships as the wvb-tauri crate (no @wvb/tauri npm package)

Verification

  • yarn build passes (client + server, all MDX compiles)
  • yarn lint clean; all internal cross-links resolve; old flat pages removed
  • Confirmed at runtime: 3 root tabs in the page tree, /docs → /docs/guide, all pages 200

Notes

The marketing home page (data.ts) still marks iOS/Android as "planned," which now contradicts the docs — left out of this PR; happy to update in a follow-up.

🤖 Generated with Claude Code

https://claude.ai/code/session_01HhaZ2zL7bAqT3c8mRWTSs9


Summary by cubic

Rebuilt the docs into Guide / References / Config with a shared SiteHeader, per-endpoint Remote HTTP spec, @wvb/bridge reference, and a new Changelog; assets now load from static.wvb.dev. Also adds a small “Experimental” badge beside the Deno entries and removes unused root docs (INDEX.md, AGENTS.md).

  • Refactors

    • Docs IA: top tabs with /docs → /docs/guide; per-endpoint Remote HTTP Spec (+ Errors); add @wvb/bridge; split Node/Deno/Bridge references into category pages; Config split (remote/integrity/signature); Changelog added.
    • Layout/assets: shared header (tabs, search, language, GitHub, theme), notebook layout, full-screen mobile menu, left-drawer sidebar; serve media from static.wvb.dev (removed bundled assets); cleaned up INDEX.md and AGENTS.md.
    • Content polish: table rendering for .wvb layout; 2‑space code blocks; Deno Desktop marked Experimental; show a small “Experimental” badge next to Guide > Deno Desktop and References > Deno API in the sidebar.
  • Bug Fixes

    • UI: hide redundant sidebar section dropdown ≥ md; fix collapsed Tabs blocks; adjust header fonts/mobile sizes; remove desktop sidebar top gap.
    • Accuracy/CI: SHA‑2 integrity; pack.outFile; wvb upload --deploy default false; version via --version; Deno page uses BundleProtocol; Node reference adds result types; config headers uses valid HeadersInit; redirect via to: '/docs/$'; build/lint/format pass.