Documentation roadmap
This page lists doc sections we should add or expand. Use it as a checklist; link new pages from the sidebar as they’re written.
Internal planning note: this page is a docs backlog, not end-user product guidance.
Recently documented (rolling)
Section titled “Recently documented (rolling)”- Roadmap —
/guides/roadmap/— public Work in progress (primarily A5; A1 staging/prod ✅) vs Future lists; kept in sync with the repo master plan. - Bug reports & AI diagnostics —
/reference/bug-reports/— crash vs AI panel reporting,aiContextfields, privacy notes. - AI edits — “When something goes wrong” + link to bug reports.
- Troubleshooting — reporting AI errors.
- Changelog — Unreleased entries for bug reporting, reliability fixes, documentation notes.
- Reference sidebar — Environment variables, runtime integration, and bug reports are grouped under Reference.
Recommended sections
Section titled “Recommended sections”Installation & setup
Section titled “Installation & setup”- Install the app — Where to download, system requirements (macOS/Windows), first launch.
- Environment variables — Reference for dev flags (
VITE_AI_GATEWAY_DEV_MODE,VITE_ACCOUNT_DEV_MODE,VITE_CLOUDFLARE_DEV_MODE) and how desktop defaults are set inapps/app/src/config.ts.
Project & template
Section titled “Project & template”- Starter template — What’s in a new project (
src/,bin/,package.json,tsconfig.json,agent.json); how the template is copied and what’s editable. - Project structure — Where projects are stored (app data dir),
project.json, linking a Webflow site per project.
Reference
Section titled “Reference”- Environment variables — Full list with defaults and behavior (see above; can live under Installation or Reference).
- Editable paths — Which files/folders the editor and AI can modify; read-only vs writable.
Webflow
Section titled “Webflow”- Embedding in Webflow — Where to paste the loader script (site/page custom code), unified loader pattern, dev-server fallback, and deployed URL behavior.
- Webflow in the app — MCP (OAuth, site selection, tools) and site-linked context for AI are shipped; see AI edits and Roadmap for deeper Designer / Webflow App tracks still on the horizon.
Troubleshooting & FAQ
Section titled “Troubleshooting & FAQ”- Troubleshooting — runtime not starting, AI token missing/session issues, build fails, publish fails, wrong model defaults.
- FAQ — Where are my projects? How do I open the projects folder? Can I use a different AI provider?
Advanced
Section titled “Advanced”- Bun runtime — App-managed Bun (no system install), version, cache location (for power users / debugging).
- Runtime config —
agent.jsonin the project, agents, MCP (e.g. Webflow).
Current docs already cover: Introduction, Projects, Editor, AI edits, Publish & embed, Account & auth. The list above extends that with installation, reference, Webflow, troubleshooting, and advanced topics.