feat(docs): fill documentation gaps across platform features

[waleedlatif1]

Summary

• New pages: chat deployment, API deployment, custom tools, variables
• Expanded: function block Python support, KB connectors (API key connectors, OCR), KB tags (slots, operators), deployment version history, MCP server config, MCP deploy-workflows (all client configs), credit purchases
• Verified all claims against codebase implementation

Type of Change

• New feature

Testing

Tested MDX compilation with bunx fumadocs-mdx

Checklist

• Code follows project style guidelines
• Self-reviewed my changes
• Tests added/updated and passing
• No new warnings introduced
• I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview, Comment	Apr 11, 2026 6:47pm

[cursor]

PR Summary

Low Risk
Low risk: documentation-only MDX and nav metadata updates with no runtime logic changes; primary risk is minor inaccuracies or broken links/examples.

Overview
Adds new documentation pages for API deployment, chat deployment, custom tools, and a new variables section, and wires them into the docs navigation (execution/meta.json, tools/meta.json, new variables/meta.json).

Expands existing docs to cover Python support in the Function block (E2B sandbox + examples), adds details on deployment version history, credit top-ups, improved MCP server/client configuration guidance, and enhances Knowledge Base docs with API-key connector setup, OCR for PDFs, and clearer tag slots/filter operators.

^{Reviewed by Cursor Bugbot for commit 6f3d1ad. Configure here.}

[greptile-apps]

Greptile Summary

This PR fills documentation gaps across multiple platform features: new pages for chat deployment, API deployment, custom tools, and variables; plus expanded content for the function block (Python support), KB connectors (API key auth, OCR), KB tags (slots/operators), deployment version history, MCP server configuration, and credit purchases. All documented claims were verified against the codebase — env variable names, resolver priority order, API response shapes, and status codes are accurate. Remaining findings are all P2 (non-blocking).

Confidence Score: 5/5

Safe to merge — all findings are P2 style/documentation-quality suggestions with no correctness impact.

All documented claims were verified against the codebase: env var names, resolver priority order, API response shapes, job status mapping, and transport type are accurate. The three findings (misplaced import, incomplete status table, missing unit annotation) are non-blocking quality suggestions.

apps/docs/content/docs/en/execution/api-deployment.mdx (incomplete status table, missing estimatedDuration unit); apps/docs/content/docs/en/execution/costs.mdx (misplaced FAQ import).

Important Files Changed

Filename	Overview
apps/docs/content/docs/en/execution/api-deployment.mdx	New file documenting sync/streaming/async API deployment modes; API shape is accurate but the job-status table omits running/waiting/admitting/admitted statuses from the workspace-dispatch path, and estimatedDuration lacks a unit annotation.
apps/docs/content/docs/en/execution/costs.mdx	New comprehensive costs file; import { FAQ } is placed after content at line 485 rather than with the other imports at the top — MDX hoists it so it compiles, but it is inconsistent with the rest of the file.
apps/docs/content/docs/en/execution/chat.mdx	New chat deployment doc; OTP cookie-jar example is correct, API shape verified.
apps/docs/content/docs/en/blocks/function.mdx	Adds Python support section with E2B sandbox details and JS vs Python comparison table; all claims verified against the executor.
apps/docs/content/docs/en/knowledgebase/connectors.mdx	Adds API-key connector table (Evernote/Obsidian/Fireflies) and OCR setup section; all env var names (OCR_AZURE_ENDPOINT, OCR_AZURE_API_KEY, OCR_AZURE_MODEL_NAME) match document-processor.ts.
apps/docs/content/docs/en/knowledgebase/tags.mdx	New tags and filtering doc with correct slot counts (17 total: 7 text, 5 number, 2 date, 3 boolean) and supported operators.
apps/docs/content/docs/en/mcp/deploy-workflows.mdx	New MCP deploy-workflows doc; env-var expansion caveat callout added for Claude Desktop/VS Code configs; all client snippets verified.
apps/docs/content/docs/en/mcp/index.mdx	Adds env-var substitution, test/validation, and domain allowlisting sections; streamable-http transport confirmed in lib/mcp/types.ts.
apps/docs/content/docs/en/tools/custom-tools.mdx	New custom-tools doc; schema format, code environment constraints, and permissions are accurate.
apps/docs/content/docs/en/variables/index.mdx	New variables overview; resolver priority order (loop → parallel → workflow → env → block) and workspace-over-personal precedence verified against executor/variables/resolver.ts and lib/environment/utils.ts.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Workflow] --> B{Deploy}
    B --> C[API Deployment\n/execution/api-deployment]
    B --> D[Chat Deployment\n/execution/chat]
    B --> E[MCP Deployment\n/mcp/deploy-workflows]
    C --> F[Sync]
    C --> G[Streaming]
    C --> H[Async\nPoll /api/jobs/jobId]
    H --> I{Status}
    I --> J[queued / waiting\nadmitting / admitted]
    I --> K[processing / running]
    I --> L[completed]
    I --> M[failed]
    D --> N[Public / Password\nEmail OTP / SSO]
    E --> O[Cursor / Claude Code\nClaude Desktop / VS Code]

Loading

_{Reviews (2): Last reviewed commit: "fix(docs): replace smart quotes with str..." | Re-trigger Greptile}

[waleedlatif1]

@greptile

[waleedlatif1]

@cursor review

[cursor]

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

^{Reviewed by Cursor Bugbot for commit 6f3d1ad. Configure here.}