Skip to content

docs(enterprise): add Custom Blocks page#5515

Merged
TheodoreSpeaks merged 3 commits into
stagingfrom
feat/custom-block-docs
Jul 8, 2026
Merged

docs(enterprise): add Custom Blocks page#5515
TheodoreSpeaks merged 3 commits into
stagingfrom
feat/custom-block-docs

Conversation

@TheodoreSpeaks

Copy link
Copy Markdown
Collaborator

Summary

Adds an Enterprise docs page for Custom Blocks — publishing a deployed workflow as a reusable, org-wide block.

The page is publishing-first and grounded in the real Settings → Enterprise → Custom blocks UI:

  • Common uses — internal API gateway, blessed knowledge lookup, governed LLM step, data enrichment, compliance gate
  • Publishing a block — 6-step walkthrough (source workflow, name/icon/description, inputs, outputs, save) with field tables and limits
  • Using a custom block — toolbar section, inputs/outputs, no source access needed
  • Managing / deleting — edit presentation only; behavior changes by redeploying the source; delete is permanent
  • Good to know, FAQ, and Self-hosted setup (DEPLOY_AS_BLOCK + NEXT_PUBLIC_CUSTOM_BLOCKS_ENABLED)

Four UI screenshots included (list page, filled-in form, editor toolbar, block on canvas).

Changes

  • New apps/docs/content/docs/en/platform/enterprise/custom-blocks.mdx + screenshots under apps/docs/public/static/enterprise/
  • Registered in the enterprise sidebar (meta.json)
  • Added docsLink to the Custom blocks settings nav item so the settings page links to the doc, like the other Enterprise pages

Notes

  • English-only (en/); translation tooling regenerates other locales
  • Internal deploy-as-block mechanics (registry overlay, invocation-boundary authz) are intentionally omitted from the body; the only DEPLOY_AS_BLOCK reference is the self-hosted env var
  • Enable/disable is not documented — I didn't find that toggle in the publish/edit form; happy to add it if you point me at the control

🤖 Generated with Claude Code

https://claude.ai/code/session_01NvLuS5o1eFjBBhEC4PytcA

@TheodoreSpeaks TheodoreSpeaks requested a review from a team as a code owner July 8, 2026 19:31
@vercel

vercel Bot commented Jul 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 8, 2026 9:13pm

Request Review

@cursor

cursor Bot commented Jul 8, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and a settings header docs URL only; no runtime or API behavior changes in this diff.

Overview
Adds Enterprise documentation for Custom Blocks — publishing a deployed workflow as an org-wide reusable block in the editor.

The new custom-blocks.mdx page covers common use cases, prerequisites (deployed workflow, workspace admin), a six-step publish walkthrough (source workflow, metadata, Start inputs/placeholders, output selection, save), consumer usage in the toolbar, edit/delete behavior (presentation vs redeploying source), operational notes (access control, disabled/undeployed states), and an FAQ. It is registered in the enterprise docs sidebar via meta.json.

The Settings → Enterprise → Custom blocks nav item now includes a docsLink to the new page, consistent with other enterprise settings sections.

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

@greptile-apps

greptile-apps Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds a new Enterprise docs page for Custom Blocks — a Fumadocs MDX page with a six-step publishing walkthrough, four UI screenshots, FAQ, and self-hosted setup instructions — plus a matching docsLink in the settings navigation so the settings panel links to the doc like other enterprise pages do.

  • custom-blocks.mdx and its screenshots are well-structured and consistent with surrounding enterprise docs; the meta.json placement and the docsLink URL both follow the established pattern.
  • apps/sim/package.json and bun.lock include an unrelated change that swaps the xlsx dependency from the official SheetJS CDN tarball to a community npm mirror (@e965/xlsx@0.20.3); this supply-chain change should be reviewed in its own PR.

Confidence Score: 4/5

The docs content and navigation changes are safe to merge; the xlsx dependency change is unrelated and needs a separate review.

The documentation page, screenshots, sidebar registration, and settings nav link are all correct and consistent with the rest of the enterprise docs. The only substantive concern is the xlsx package swap bundled into this PR: it switches from the official SheetJS CDN tarball to a community-maintained npm mirror published by a single GitHub user, which is a supply-chain change that deserves its own PR and explicit sign-off from the team.

apps/sim/package.json and bun.lock — the xlsx → @e965/xlsx swap is unrelated to the docs work and should be reviewed independently.

Important Files Changed

Filename Overview
apps/docs/content/docs/en/platform/enterprise/custom-blocks.mdx New Enterprise docs page for Custom Blocks — well-structured, uses consistent components (Callout, Image, FAQ), clear step-by-step publishing walkthrough, and includes self-hosted env var setup. No issues found.
apps/docs/content/docs/en/platform/enterprise/meta.json Adds custom-blocks between access-control and whitelabeling in the enterprise sidebar — correct placement, no issues.
apps/sim/app/workspace/[workspaceId]/settings/navigation.ts Adds docsLink to the custom-blocks nav item, consistent with the URL pattern used by all other enterprise settings entries.
apps/sim/package.json xlsx dependency switched from official SheetJS CDN tarball to the community mirror @e965/xlsx@0.20.3 — an unrelated supply-chain change bundled into a docs PR that warrants its own review.
bun.lock Lockfile updated to reflect the xlsx → @e965/xlsx package switch; mirrors the package.json change.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Deploy source workflow] --> B[Settings → Enterprise → Custom blocks]
    B --> C[Create block]
    C --> D[Select Workspace & Workflow]
    D --> E[Name / Icon / Description]
    E --> F[Configure input placeholders]
    F --> G[Choose outputs to expose]
    G --> H[Save — block published org-wide]

    H --> I[Workflow Editor toolbar]
    I --> J[Custom Blocks section]
    J --> K[Drag block onto canvas]
    K --> L[Fill inputs & wire outputs]

    H --> M[Manage in Settings]
    M --> N{Action}
    N -- Edit --> O[Update presentation only]
    N -- Redeploy source --> P[Block picks up new behavior automatically]
    N -- Delete --> Q[Permanent — removed from all workflows]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[Deploy source workflow] --> B[Settings → Enterprise → Custom blocks]
    B --> C[Create block]
    C --> D[Select Workspace & Workflow]
    D --> E[Name / Icon / Description]
    E --> F[Configure input placeholders]
    F --> G[Choose outputs to expose]
    G --> H[Save — block published org-wide]

    H --> I[Workflow Editor toolbar]
    I --> J[Custom Blocks section]
    J --> K[Drag block onto canvas]
    K --> L[Fill inputs & wire outputs]

    H --> M[Manage in Settings]
    M --> N{Action}
    N -- Edit --> O[Update presentation only]
    N -- Redeploy source --> P[Block picks up new behavior automatically]
    N -- Delete --> Q[Permanent — removed from all workflows]
Loading

Reviews (1): Last reviewed commit: "docs(enterprise): add Custom Blocks page" | Re-trigger Greptile

Comment thread apps/sim/package.json Outdated
Document publishing a deployed workflow as a reusable org-wide block:
publishing flow, common uses, using a block, managing, and self-hosted
setup, with UI screenshots. Register in the enterprise sidebar and wire
the settings docsLink.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NvLuS5o1eFjBBhEC4PytcA
The page's Enterprise placement is implicit, so remove the "Enterprise
feature" callout and plan mentions. Add that custom blocks can be
allowlisted per permission group via Access Control.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NvLuS5o1eFjBBhEC4PytcA
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NvLuS5o1eFjBBhEC4PytcA
@TheodoreSpeaks TheodoreSpeaks changed the base branch from main to staging July 8, 2026 21:36
@TheodoreSpeaks TheodoreSpeaks merged commit d30eb36 into staging Jul 8, 2026
22 checks passed
@TheodoreSpeaks TheodoreSpeaks deleted the feat/custom-block-docs branch July 8, 2026 21:36
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