-
Notifications
You must be signed in to change notification settings - Fork 3.2k
improvement(docs): updated docs with new videos, new tools #744
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Summary
This PR significantly enhances the documentation with several key improvements:
- Reorganizes documentation structure by creating a dedicated 'triggers' section, separating trigger-related content from blocks
- Replaces static images with interactive video demonstrations across multiple sections (variables, execution basics)
- Adds comprehensive documentation for new tools and features:
- New Slack capabilities (canvas creation, message reading)
- Enhanced Supabase integration with more granular database operations
- New Exa AI research functionality
- Expanded Notion integration with database operations
- Firecrawl website crawling capabilities
- Improves visual elements with proper branding (e.g., Typeform logo update)
Confidence score: 4/5
- This PR is safe to merge as it only contains documentation changes with no code modifications
- High confidence due to well-structured documentation changes and proper organization, slightly reduced due to some incomplete sections in new trigger documentation
- Files needing attention:
- apps/docs/content/docs/triggers/webhook.mdx (incomplete security documentation)
- apps/docs/content/docs/tools/schedule.mdx (missing detailed configuration examples)
- apps/docs/content/docs/tools/supabase.mdx (incomplete PostgREST filter examples)
18 files reviewed, 12 comments
|
|
||
| | Parameter | Type | Required | Description | | ||
| | --------- | ---- | -------- | ----------- | | ||
| | `webhookProvider` | dropdown | Yes | Webhook Provider | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Description for webhookProvider parameter is too vague. Should include available providers and their specific use cases.
|
|
||
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Large empty gap between BlockInfoCard and Block Configuration section. Remove extra newlines.
| /> | |
| ## Block Configuration |
| | `pages` | string | | ||
| | `total` | string | | ||
| | `creditsUsed` | string | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Output types for pages, total, and creditsUsed should be specified more precisely. Consider using array<string>, number, and number respectively instead of string.
|
|
||
| | Parameter | Type | | ||
| | --------- | ---- | | ||
| | `messages` | string | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Output type for messages should be 'json[] | object[]' instead of 'string' since it returns structured message data
| <Callout> | ||
| Starter blocks are ideal for testing workflows and user-initiated tasks. For automated execution, use Schedule or Webhook triggers. | ||
| </Callout> No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: consider adding links to the Schedule and Webhook trigger documentation mentioned in the Callout
| | `scheduleConfig` | schedule-config | Yes | Schedule Status | | ||
| | `scheduleType` | dropdown | Yes | Frequency | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Add details about valid values for scheduleConfig and scheduleType. What frequencies are supported? What format is expected?
|
|
||
| import { Callout } from 'fumadocs-ui/components/callout' | ||
| import { Tab, Tabs } from 'fumadocs-ui/components/tabs' | ||
| import { ThemeImage } from '@/components/ui/theme-image' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: ThemeImage is imported but never used in the document
| import { ThemeImage } from '@/components/ui/theme-image' | |
| import { Callout } from 'fumadocs-ui/components/callout' | |
| import { Tab, Tabs } from 'fumadocs-ui/components/tabs' |
| | `table` | string | Yes | The name of the Supabase table to query | | ||
| | `filter` | object | No | Filter to apply to the query | | ||
| | `apiKey` | string | Yes | Your Supabase client anon key | | ||
| | `filter` | string | No | PostgREST filter \(e.g., | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Filter example is incomplete - add example format for PostgREST filter syntax to help users understand the expected format
| | --------- | ---- | -------- | ----------- | | ||
| | `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) | | ||
| | `table` | string | Yes | The name of the Supabase table to query | | ||
| | `filter` | string | Yes | PostgREST filter to find the specific row \(e.g., | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Missing example for filter criteria in single row lookup - add example to clarify expected format
| | --------- | ---- | -------- | ----------- | | ||
| | `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) | | ||
| | `table` | string | Yes | The name of the Supabase table to update | | ||
| | `filter` | string | Yes | PostgREST filter to identify rows to update \(e.g., | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Filter example missing in update operation - add example format for consistency with other operations
|
✅ No security or compliance issues detected. Reviewed everything up to 9a84bfb. Security Overview
Detected Code Changes
Reply to this PR with |
* updated docs with new videos, new tools * update typeform icon
* improvement(docs): updated docs with new videos, new tools (#744) * updated docs with new videos, new tools * update typeform icon * add qdrant docs
…ai#744) * updated docs with new videos, new tools * update typeform icon
…ai#770) * improvement(docs): updated docs with new videos, new tools (simstudioai#744) * updated docs with new videos, new tools * update typeform icon * add qdrant docs
Description
Updated docs with new videos, new tools
Type of change
How Has This Been Tested?
NA
Checklist:
bun run test)Security Considerations: