Skip to content

docs: builder-first IA reorganization of the English docs#4896

Open
ouiliame wants to merge 1 commit into
simstudioai:stagingfrom
ouiliame:feat/docs-reorg
Open

docs: builder-first IA reorganization of the English docs#4896
ouiliame wants to merge 1 commit into
simstudioai:stagingfrom
ouiliame:feat/docs-reorg

Conversation

@ouiliame
Copy link
Copy Markdown

@ouiliame ouiliame commented Jun 6, 2026

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-line bun.lock (new component deps).

Targeting staging.

Highlights

Navigation & structure

  • Sidebar now follows how someone builds: Get Started → Workflows → Tables → Files → Knowledge Bases → Logs → Building agents → Mothership → Workspaces → Platform → Reference.
  • Generated blocks/tools/triggers catalogs demoted to a Reference section at the bottom.
  • Monolithic execution/ split into deployment/ and logs-debugging/; connections/* and variables/* collapsed into single pages under workflows/.
  • capabilities/ renamed to building-agents/; integration catalog relabeled "Integrations". Deprecated copilot and form deployment removed. Every moved URL has a permanent redirect in next.config.ts.

Conceptual rewrites

  • Workflows core rewritten around one mental model and one running example.
  • 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, and Triggers overviews; new task pages (using-in-workflows) for KB, Tables, and Files.
  • New, code-verified Alerts page.

Infrastructure

  • pageType frontmatter (concept/guide/reference) + a small badge near the page title.
  • WorkflowPreview / OutputBundle components that embed real, app-styled workflow diagrams instead of screenshots (adds framer-motion + reactflow to apps/docs).

Scope & known gaps

  • English (en) only. Other locales (de/es/fr/ja/zh) are untouched and still on the previous structure — a follow-up.
  • Logs query API reference (GET /api/v1/logs and related) was part of the removed execution/api page and is not yet re-homed in /api-reference, because the generated OpenAPI reference currently only emits workflows + human-in-the-loop. Flagging so it's tracked, not treated as an accidental drop.
  • Several pages contain {/* VISUAL: ... */} authoring placeholders for diagrams not yet rendered; prose stands alone, those are follow-up art.

🤖 Generated with Claude Code

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>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 6, 2026

@ouiliame is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

@cursor
Copy link
Copy Markdown

cursor Bot commented Jun 6, 2026

PR Summary

Low Risk
Docs-only changes with no runtime product impact; main risk is broken bookmarks or missing redirects until the logs API reference is re-homed.

Overview
Reorganizes English docs only around a builder-first information architecture: workflows, tables, files, knowledge bases, deployment, and logs/debugging replace the old execution/ and connections/ trees, with generated block/tool catalogs moved under Reference.

Content and UX: Conceptual pages are rewritten (workflows mental model, new building-agents/ with agent vs Agent block and a choosing guide, trimmed overviews, new task pages like using-in-workflows for KB/tables/files, deployment overview, alerts, debugging retrieval). Copilot and form-deployment docs are removed; many internal links now point at /workflows/*, /deployment/*, /logs-debugging/*, and /api-reference/*.

Docs app: Adds optional pageType frontmatter with a PageTypeBadge on MDX pages (and drops DocsDescription from the page header). Introduces WorkflowPreview / OutputBundle (React Flow + Framer Motion) for in-page workflow diagrams instead of static screenshots.

Caveat (called out in the PR): The former execution/api logs/webhooks reference is not yet re-homed under /api-reference; other locales still use the old structure.

Reviewed by Cursor Bugbot for commit 18cee3d. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ 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>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 18cee3d. Configure here.

@ouiliame ouiliame marked this pull request as draft June 6, 2026 01:24
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jun 6, 2026

Greptile Summary

This 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 pageType Diátaxis badge and a WorkflowPreview/OutputBundle component system that embeds live ReactFlow diagrams in MDX. All moved URLs have permanent redirects in next.config.ts.

  • Sidebar restructured: Get Started → Workflows → Tables → Files → Knowledge Bases → Logs → Building agents → Mothership → Workspaces → Platform → Reference. Generated catalogs (blocks/tools/triggers) demoted to a Reference section.
  • WorkflowPreview and OutputBundle React components added, backed by ReactFlow 11 + Framer Motion 12; four static example workflows defined in examples.ts with unique IDs, keyed on the ReactFlowProvider to force remount on highlight changes.
  • pageType frontmatter field added via a Zod schema extension in source.config.ts, rendered as a small Diátaxis-mode badge in page.tsx; DocsDescription intentionally removed from the page template in favour of first-paragraph prose in each MDX body.

Confidence Score: 5/5

Docs-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

Filename Overview
apps/docs/next.config.ts 32 permanent redirects added for moved/removed URLs; two redirect chains (capabilities/agents and execution/form) incur two round-trips but this was already flagged in a previous thread
apps/docs/components/workflow-preview/workflow-preview.tsx New ReactFlow-based read-only workflow diagram component; ReactFlowProvider keyed on workflow.id+highlight props to force remount on changes; nodes state correctly resets because of the key, but animate prop is not part of the key
apps/docs/components/page-type-badge.tsx New Diátaxis badge component; uses satisfies Record to enforce exhaustive CONFIG coverage at compile time; runtime null guard is harmless
apps/docs/app/[lang]/[[...slug]]/page.tsx Adds PageTypeBadge before DocsTitle; removes DocsDescription from visual rendering while keeping it in SEO metadata (StructuredData, generateMetadata); change is intentional for pages rewritten in this PR
apps/docs/source.config.ts Extends frontmatter schema with optional pageType enum via Zod; backward-compatible since field is optional
apps/docs/content/docs/en/meta.json Root sidebar restructured; all referenced files verified to exist on disk; individual knowledgebase/mothership pages listed flat rather than as folder groups, consistent with their respective meta.jsons
apps/docs/package.json Adds reactflow ^11.11.4 and framer-motion ^12.5.0 to docs app dependencies

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
Loading

Reviews (2): Last reviewed commit: "docs: reorganize into topic/ontology IA ..." | Re-trigger Greptile

Comment thread apps/docs/next.config.ts
Comment on lines +36 to +52
{ 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 },
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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!

@waleedlatif1 waleedlatif1 marked this pull request as ready for review June 6, 2026 01:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant