Added
-
π Project-wide documentation overhaul β The README, the
docs/repo, and the marketing site (website/) were rewritten end-to-end by a pro doc pass. ~2,000 insertions / ~1,600 deletions across 29 files. Public behaviour is unchanged; this is a content-only release. -
Reordered README around the product priority β TUI β Web β Agent Extensions β Smart Model Router (last). The router and the extensions moved out of the middle of the doc and into dedicated sections at the end, so the TUI and the Web Dashboard (the two core surfaces) are now the centerpiece of the reading flow.
-
Expanded Quick Start β grew from a 3-step outline to a 6-step user-centric walkthrough (Install β Grab a key β Launch & paste β Pick & launch β The 30-second cool tour β Go further). Each step links to the relevant deep section. Includes a
headlesssidebar (--json,--fiable) and apre-target a tool from the command lineexample block. -
π’ Free AI Providers β kept the 20-provider table near the top, but now sits after Quick Start with a clean
β οΈ Health checks consume provider quotanote and a collapsibleπ§Ή Providers removed from the catalogdetails block. -
ποΈ TUI section β now opens with a
First-run flow(3 steps), then 7 user-framed workflows ("Give me the fastest model that actually works","Pick a model & launch","Benchmark before I commit","Smart Recommend","Keep my go-to models pinned","Switch tools without restarting","My terminal theme fights the TUI colors"), followed by the complete keyboard reference and a mouse reference. -
π Web Dashboard β feature table condensed,
web(port 3333) vs--daemon(port 19280) port distinction made explicit, Docker quick-start + image tags + env vars + compose + troubleshooting all in one place. -
π 19 per-tool integration pages β replaced the previous 3 generic integration pages (
opencode,pi-extension,openclaw) with a dedicated page for every supported target: OpenCode, Pi, OpenClaw, Crush, Goose, Aider, Kilo, Hermes, Continue, Cline, Amp, Qwen Code, ForgeCode, ZCode, jcode, Caveman Code, Copilot CLI, OpenHands, Xcode Intelligence. Each page documents the launch flag, the exact config file FCM writes (path + JSON example verified againstsrc/core/tool-launchers.js), the install/bootstrap behaviour, and (for OpenCode + Pi) the in-agent plugin commands. -
OpenCode + Pi merged into one page per tool β
integrations/opencode.mdxandintegrations/pi.mdxeach combine the FCM launch flow (CLI flag, config, install) with the in-agent plugin (/fcmcommands, progress display, architecture). The oldpi-extensionslug redirects topiso any external link still resolves. -
π 5 video wrappers added across the docs and the landing β
<Video name="β¦" />placeholders for the 5 planned screen recordings (tui-first-launch,tui-pick-and-launch,tui-speed-test,web-url-deep-linking,router-playground). On the doc pages a<Callout>immediately below each wrapper contains the recording script (shot list, export spec, file location) and a{/* AGENT TODO: β¦ */}comment that tells the next agent exactly which block to delete once the.mp4is committed. On the landing page the wrappers are bare β no Callout, because the landing is public. -
π§ Persistent site component changes β a new
<Video />component (website/src/components/Video.tsx) renders an autoplay / muted / loop / playsinline<video>in a styled figure. The Markdown renderer now wraps every MDX<table>in a.table-scrollcontainer so wide tables scroll inside the page instead of pushing the viewport wider, and the first column gets amin-width: 8remso label columns (e.g. the "Area" column in the Web Dashboard features table) stay readable. The "On this page" right-side table-of-contents was removed from every docs page; the content was already in flow and the column was redundant. -
Sidebar "View more" toggle on long nav groups β
Agent Integrationsnow lists the 9 most-used tools in the user's preferred order (OpenCode, Pi, Hermes, OpenClaw, Qwen Code, Cline, Goose, Kilo, jcode) and hides the remaining 10 behind a "+ View 10 moreβ¦" toggle that expands to "- View less". The active page is always shown even when the group is collapsed, so you never lose your place in the nav. -
Repository docs cleaned up β
docs/config.mdno longer lists the deprecated providers that were removed from the active catalog (huggingface, replicate, deepinfra, siliconflow, together, perplexity); the env-var table is now aligned with the 20 active providers.docs/development.mdis updated from the stale160 models across 20 providersfigure to the real222 models, and the file-path table is rewritten from the obsoletesrc/*.jslayout to the currentsrc/core/,src/tui/,src/data/structure.docs/integrations.mdnow lists 19 tools + the FCM router in the tool β config mapping. -
Marketing site MDX content realigned β the entire
website/src/content/docs/tree was rewritten to match the README. Architectural inaccuracies (e.g.Gemini CLIreferenced as a provider, fabricated REST endpoints like/api/best, half-true circuit-breaker states) were corrected against the source code and the README. Thecli-tui.mdxkeybinding table was rebuilt from the README so it is now 100% accurate (fixing the historical bugs whereNwas mislabelled as "Sort by Context" andYwas mislabelled as "Sort by Tier"). The docs nav sidebar was reordered so the surfaces (TUI, Web, Docker) come first, the agent integrations follow, and the Smart Router is the last item in "Core concepts & advanced" β matching the README's reading order. -
Landing-page video integration β the static
LogoMark+MorphingTextcontent in the Hero card was replaced with the<Video name="tui-first-launch">wrapper so the first thing a visitor sees becomes a live demo as soon as the recording lands. The router demo is embedded in the FailoverSection, and the remaining three demos live in a new "See it live" grid at the bottom of the SurfacesSection.
Changed
- README "double title" bug β every docs page used to render the title twice (once in the route header, once in the leading
# Titleof the MDX body). All 18 MDX files had their leading# <Title>line removed; the route header is now the single source of truth for the page title. - Markdown renderer table overflow β the previous
.prose table { white-space: nowrap }rule forced every cell onto a single line, which exploded the page width whenever a cell contained a long description (e.g. the "Highlights" column in the Web Dashboard features table). Tables now wrap their content (overflow-wrap: anywhere) and live inside a horizontal-scroll wrapper as a fallback so even pathological tables scroll inside the page instead of stretching the viewport. README.mdnow contains 5 video references β the same 5 recordings are available on the landing and the docs; all three surfaces reference the same files inwebsite/public/videos/. Mutualised, no duplication.- Removed
pi-extension.mdxβ superseded by the mergedintegrations/pi.mdx. A redirect from the old slug lives indocs/$.tsxso any external link still resolves.
Migration / workaround
No code or behaviour changes. This release is documentation-only. No new flags, no new endpoints, no breaking changes. Upgrade is safe and invisible to runtime users.
The 5 videos are not yet recorded. The wrappers currently render empty
<video>frames everywhere. Drop the recorded.mp4files atwebsite/public/videos/<name>.mp4and the surrounding<Callout>recording scripts in the docs remove themselves via the{/* AGENT TODO: β¦ */}comment the next time an agent touches them. Public behaviour is unchanged.
Files
- Modified:
README.md(full rewrite, ~1,000 lines),docs/config.md,docs/development.md,docs/integrations.md, 16 docs MDX files underwebsite/src/content/docs/,website/src/components/MdxComponents.tsx(registersVideo,table),website/src/components/DocsSidebar.tsx(refactored withNavGroup+View moretoggle),website/src/routes/index.tsx(landing videos + import cleanup),website/src/routes/docs/$.tsx(TOC removed,pi-extensionredirect),website/src/styles.css(table wrapping + scroll wrapper,.table-scrollactivated),website/src/content/nav.ts(reordered +primaryCount),package.json(0.5.65β0.5.66), this changelog. - New:
website/src/components/Video.tsx(~35 lines). - New folder:
website/public/videos/(target for the 5 upcoming recordings). - Deleted:
website/src/content/docs/integrations/pi-extension.mdx(replaced byintegrations/pi.mdx; redirect handles old links).
Breaking changes
None. This is a documentation-only release. No CLI flags added, no flags removed, no endpoints changed, no behaviour changed.