feat(docs): fill documentation gaps across platform features#4110
feat(docs): fill documentation gaps across platform features#4110waleedlatif1 merged 18 commits intostagingfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
PR SummaryLow Risk Overview Updates existing docs to reflect new/changed capabilities: Function block now documents Python execution (tabs + E2B sandbox details), Copilot page is rewritten/trimmed with updated setup/checkpoint guidance, Knowledge Base docs expand connectors and tags/filtering behavior, and Execution docs add deployment version history plus credit-purchase info. Also includes small docs-app tweaks: 404 page layout adds a “Go home” link, and Reviewed by Cursor Bugbot for commit 24387e7. Bugbot is set up for automated code reviews on this repo. Configure here. |
Greptile SummaryThis 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/5Safe 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
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]
Reviews (2): Last reviewed commit: "fix(docs): replace smart quotes with str..." | Re-trigger Greptile |
… var placeholders
|
@greptile |
|
@cursor review |
There was a problem hiding this comment.
✅ 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.
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 99a1ac0. Configure here.
| |--------|-------------------| | ||
| | Create or update custom tools | **Write** or **Admin** | | ||
| | Delete custom tools | **Admin** | | ||
| | Use custom tools in agents | **Read**, **Write**, or **Admin** | |
There was a problem hiding this comment.
Duplicate custom tools pages with inconsistent content
Low Severity
Two new pages both titled "Custom Tools" were added — custom-tools/index.mdx (under Features) and tools/custom-tools.mdx (under Tools). They cover the same topic with overlapping content but diverge on details: the overview says "three parts" (Schema, Code, Scope) while the reference says "two parts" (Schema, Code), and their permission tables conflict. Consolidating into one page with a redirect from the other would prevent future drift.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit 99a1ac0. Configure here.
Extends scripts/generate-docs.ts to produce one MDX page per trigger provider (39 pages) in apps/docs/content/docs/en/triggers/. The 5 hand-written pages (index, start, schedule, webhook, rss) are never touched. Key additions to the generation script: - resolveConstVariable() resolves module-level const spreads so providers like Vercel that build outputs from const variables (not just functions) are fully documented - resolveTriggerBuilderFunction() extended to expand variable spreads (...varName) in addition to function-call spreads (...fn()) - groupTriggersByProvider() deduplicates v1/v2 trigger variants by name, keeping the highest-versioned one per provider - writeIconMapping() adds bare-name aliases for versioned block types (github_v2 → github, fireflies_v2 → fireflies, etc.) so BlockInfoCard resolves icons for all 39 trigger providers - extractTriggerConfigFields() filters readOnly display blocks (webhook URL displays, sample payloads, curl examples) from config tables Each generated page includes: BlockInfoCard with correct icon/color, trigger count, polling note where applicable, Configuration table, and Output table for every trigger. No "Type:" lines.
- Use ### `trigger_id` headings (matching ### `tool_id` in tools docs) - Wrap all trigger sections under a ## Triggers header - Rename Configuration/Output to #### level (matching #### Input/Output) - Use Parameter column header to match tools docs table style - Map UI widget types to semantic types: short-input/long-input/dropdown → string, switch → boolean, slider → number, oauth-input → string
Trigger IDs are internal identifiers; users scan by name. Switch from ### `trigger_id` to ### Trigger Name for cleaner sidebar navigation and better readability.
…sections
Extends generate-docs.ts to parse subBlock builder functions so all 15
providers previously missing Configuration sections now generate them.
Handles three patterns:
- `buildTriggerSubBlocks({extraFields: buildX(...)})` — extracts extra
fields from the call site and resolves them from the provider's utils.ts
- `return [...]` — direct array return (Attio, Confluence, etc.)
- `blocks.push(...)` — imperative push pattern (Linear, Ashby)
Also resolves const-reference field IDs (SCREAMING_CASE) by searching
the webhook provider constants cache, fixing Gong's `gongJwtPublicKeyPem`
field which was previously unresolvable. Adds title-as-description fallback
for OAuth credential fields that have no explicit description.
Fixes a parser bug where output fields with no top-level `type` key but child fields each having their own `type`/`description` were incorrectly parsed. The `type:` and `description:` regex matches were not depth-aware, so values from nested children bled into the parent field. Changes: - Add `isAtDepthZero()` helper for brace-depth-aware regex matching - Fix `parseFieldContent` to only match `type:` at brace depth 0 - Fix `extractDescription` to only match `description:` at brace depth 0 - Add implicit-object fallback: when no top-level `type` exists but child fields have their own types, treat as `object` with `properties` - Regenerate all affected trigger docs (Cal.com payload, Linear data, Jira issue.fields, Ashby application, Greenhouse candidate, etc.)


Summary
Type of Change
Testing
Tested MDX compilation with
bunx fumadocs-mdxChecklist