docs: builder-first IA reorganization of the English docs#4896
Conversation
Restructure the English docs from internal product categories into a topic-based information architecture, and rewrite the conceptual pages to install a mental model first rather than enumerate features. Structure & navigation - Reorder the sidebar to follow how someone builds: Get Started -> Workflows -> Tables -> Files -> Knowledge Bases -> Logs -> Building agents -> Mothership -> Workspaces -> Platform -> Reference. - Demote the generated blocks/tools/triggers catalogs to a Reference section at the bottom. - Break up the monolithic execution/ folder into deployment/ and logs-debugging/; collapse connections/* and variables/* into single pages under workflows/. - Rename capabilities/ to building-agents/; relabel the integration catalog as "Integrations". Remove deprecated copilot and form deployment. Redirects added in next.config.ts for every moved URL. Conceptual rewrites - Workflows core (index, how-it-runs, data-flow, connections, variables): one mental model, one running example, terser prose. - New building-agents overview distinguishes an agent (a workflow you build) from an Agent block (one reasoning step), plus a "choosing what to use" guide. - Concept-trim passes on Knowledge Base, Tables, Blocks, Triggers overviews; new task pages for KB, Tables, and Files. - New code-verified Alerts page. Infrastructure - pageType frontmatter (concept/guide/reference) + badge render. - WorkflowPreview / OutputBundle components to embed real, app-styled workflow diagrams (adds framer-motion + reactflow to apps/docs). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
@ouiliame is attempting to deploy a commit to the Sim Team on Vercel. A member of the Team first needs to authorize it. |
PR SummaryLow Risk Overview Content and UX: Conceptual pages are rewritten (workflows mental model, new Docs app: Adds optional Caveat (called out in the PR): The former Reviewed by Cursor Bugbot for commit 18cee3d. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 18cee3d. Configure here.
| highlightBlock={highlightBlock} | ||
| highlightEdge={highlightEdge} | ||
| /> | ||
| </ReactFlowProvider> |
There was a problem hiding this comment.
Duplicate React provider keys
Medium Severity
WorkflowPreview keys ReactFlowProvider only from workflow.id, highlightBlock, and highlightEdge. The workflows overview renders two previews with the same CLASSIFY_WORKFLOW and highlightBlock="agent", so React sees duplicate sibling keys and can reuse the wrong internal flow state between diagrams.
Reviewed by Cursor Bugbot for commit 18cee3d. Configure here.
Greptile SummaryThis PR reorganizes the English docs from a product-category IA into a builder-first topic structure, rewrites key conceptual pages, and introduces two new infrastructure pieces: a
Confidence Score: 5/5Docs-only change with no runtime logic outside of two new React components and redirect rules; all redirects verified against deleted files, all sidebar page references verified to exist on disk. The WorkflowPreview/OutputBundle components are client-only and isolated to the docs app. The ReactFlowProvider key correctly includes workflow.id plus the two highlight props, so state resets whenever the diagram content changes. The pageType schema extension is backward-compatible (field is optional). Redirect coverage is complete for every removed path. No application code outside apps/docs is touched. No files require special attention. The two-hop redirect chains in next.config.ts (capabilities/agents and execution/form) were already flagged in a previous review thread. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
subgraph WorkflowPreview["WorkflowPreview (client)"]
WP["WorkflowPreview\n(wrapper, key = workflow.id + highlights)"]
RFP["ReactFlowProvider\n(remounts on key change)"]
PF["PreviewFlow\n(useState nodes/edges)"]
PBS["PreviewBlockNode\n(framer-motion m.div)"]
PE["PreviewEdge\n(m.path or path)"]
end
subgraph Data["Static data (examples.ts)"]
CW["CLASSIFY_WORKFLOW"]
CRW["CLASSIFY_REPLY_WORKFLOW"]
SKW["SUPPORT_KB_WORKFLOW"]
TEW["TABLE_ENRICH_WORKFLOW"]
end
subgraph Transform["workflow-data.ts"]
TRF["toReactFlowElements()"]
end
subgraph Badge["pageType badge"]
SC["source.config.ts\n(Zod schema extension)"]
LS["lib/source.ts\n(DocsPageType type)"]
PTB["PageTypeBadge component"]
end
MDX["MDX page\n(server component)"] -->|imports| WP
MDX -->|frontmatter pageType| SC
SC --> LS
LS --> PTB
PTB --> PageTsx["page.tsx"]
Data --> WP
WP --> RFP
RFP --> PF
PF -->|useMemo| TRF
TRF -->|nodes| PBS
TRF -->|edges| PE
Reviews (2): Last reviewed commit: "docs: reorganize into topic/ontology IA ..." | Re-trigger Greptile |
| { source: '/capabilities/agents', destination: '/building-agents/agents', permanent: true }, | ||
| { | ||
| source: '/capabilities/choosing', | ||
| destination: '/building-agents/choosing', | ||
| permanent: true, | ||
| }, | ||
| // execution/* was broken up; redirect old URLs to their new homes | ||
| { source: '/execution', destination: '/workflows', permanent: true }, | ||
| { source: '/execution/index', destination: '/workflows', permanent: true }, | ||
| { source: '/execution/basics', destination: '/workflows/how-it-runs', permanent: true }, | ||
| { source: '/execution/files', destination: '/files/passing-files', permanent: true }, | ||
| { source: '/execution/logging', destination: '/logs-debugging/logging', permanent: true }, | ||
| { source: '/execution/costs', destination: '/costs', permanent: true }, | ||
| { source: '/execution/api', destination: '/api-reference/getting-started', permanent: true }, | ||
| { source: '/execution/api-deployment', destination: '/deployment/api', permanent: true }, | ||
| { source: '/execution/chat', destination: '/deployment/chat', permanent: true }, | ||
| { source: '/execution/form', destination: '/deployment/form', permanent: true }, |
There was a problem hiding this comment.
Two-hop redirect chains on deprecated URLs
Two redirect chains are introduced here. /capabilities/agents first hits the /building-agents/agents rule (line 23) before bouncing again to /building-agents, and /execution/form first hits /deployment/form (line 25) before going to /deployment. With permanent: true (308), browsers eventually cache both hops, but the first visit still pays two round trips and search-engine crawlers must follow two hops to update index URLs. Both chains can be collapsed to a single hop by pointing the old source directly at the final destination.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


What this does
Reorganizes the English documentation from internal product categories into a topic/ontology-based information architecture, and rewrites the conceptual pages to install a mental model first rather than enumerate features. Docs-only — one commit,
apps/docs/**plus a two-linebun.lock(new component deps).Targeting
staging.Highlights
Navigation & structure
blocks/tools/triggerscatalogs demoted to a Reference section at the bottom.execution/split intodeployment/andlogs-debugging/;connections/*andvariables/*collapsed into single pages underworkflows/.capabilities/renamed tobuilding-agents/; integration catalog relabeled "Integrations". Deprecated copilot and form deployment removed. Every moved URL has a permanent redirect innext.config.ts.Conceptual rewrites
building-agentsoverview distinguishes an agent (a workflow you build) from an Agent block (one reasoning step), plus a "choosing what to use" guide.using-in-workflows) for KB, Tables, and Files.Infrastructure
pageTypefrontmatter (concept/guide/reference) + a small badge near the page title.WorkflowPreview/OutputBundlecomponents that embed real, app-styled workflow diagrams instead of screenshots (addsframer-motion+reactflowtoapps/docs).Scope & known gaps
en) only. Other locales (de/es/fr/ja/zh) are untouched and still on the previous structure — a follow-up.GET /api/v1/logsand related) was part of the removedexecution/apipage and is not yet re-homed in/api-reference, because the generated OpenAPI reference currently only emitsworkflows+human-in-the-loop. Flagging so it's tracked, not treated as an accidental drop.{/* VISUAL: ... */}authoring placeholders for diagrams not yet rendered; prose stands alone, those are follow-up art.🤖 Generated with Claude Code