-
Notifications
You must be signed in to change notification settings - Fork 3.2k
improvement(docs): updated docs with new videos, new tools #770
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
* updated docs with new videos, new tools * update typeform icon
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
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 Sim Studio documentation through a comprehensive reorganization and expansion of content. The changes include:
Documentation Structure Improvements:
- Reorganized webhook triggers from the blocks section to a new dedicated triggers section
- Added proper navigation structure with meta.json files for the triggers section
- Consolidated trigger documentation under
/triggers/directory with separate pages for starter, schedule, and webhook triggers
Enhanced Visual Content:
- Replaced static images with dynamic video demonstrations across multiple documentation sections
- Updated execution basics documentation with videos showing manual execution, scheduled execution, API deployment, and webhook configuration
- Added video content to variables documentation and trigger pages
Tool Integration Expansions:
- Notion: Added four new tools (
notion_read_database,notion_query_database,notion_search,notion_create_database) and simplified thenotion_create_pagetool - Supabase: Enhanced with full CRUD operations (
supabase_get_row,supabase_update,supabase_delete) and improved query parameters - Slack: Added
slack_canvasfor collaborative documents andslack_message_readerfor message history - Firecrawl: Added
firecrawl_crawltool for website crawling capabilities - Exa: Added
exa_researchtool for comprehensive AI-powered research
Visual Brand Updates:
- Updated Typeform icon with official brand logo in both the icons component and documentation
- Fixed JSX compatibility issues (clipPath attribute) and corrected output documentation for Qdrant
The changes follow established documentation patterns and maintain consistency with the existing codebase architecture. The reorganization creates a more logical information hierarchy where triggers are properly separated from processing blocks, and the enhanced tool documentation provides comprehensive coverage of expanded API capabilities.
Confidence score: 3/5
- This PR contains mostly safe documentation updates but has several issues that need attention before merging
- The score reflects incomplete documentation (truncated filter examples in Supabase), potential misplaced files (webhook.mdx in tools instead of triggers), and documentation for tools that may not be implemented yet
- Files needing attention: apps/docs/content/docs/tools/supabase.mdx (incomplete filter examples), apps/docs/content/docs/tools/webhook.mdx (misplaced file), apps/docs/content/docs/tools/exa.mdx (potentially premature documentation), apps/docs/content/docs/tools/schedule.mdx (duplicate/misplaced content)
20 files reviewed, 14 comments
| | `accessToken` | string | Yes | Notion OAuth access token | | ||
| | `parentId` | string | Yes | ID of the parent page where the database will be created | | ||
| | `title` | string | Yes | Title for the new database | | ||
| | `properties` | string | No | Database properties as JSON object \(optional, will create a default | |
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.
syntax: Description appears truncated - 'will create a default' is incomplete
| | `properties` | string | No | Database properties as JSON object \(optional, will create a default | | |
| | `properties` | string | No | Database properties as JSON object \(optional, will create a default title property if not specified\) | |
| | `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.
syntax: Filter example is incomplete - the description cuts off after 'e.g.,' without showing an actual example
| | `filter` | string | No | PostgREST filter \(e.g., | | |
| | `filter` | string | No | PostgREST filter \(e.g., `name.eq.John` or `age.gt.18`\) | |
| | --------- | ---- | -------- | ----------- | | ||
| | `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.
syntax: Same issue - filter example is truncated and incomplete
| | `filter` | string | Yes | PostgREST filter to find the specific row \(e.g., | | |
| | `filter` | string | Yes | PostgREST filter to find the specific row \(e.g., `id.eq.123` or `email.eq.user@example.com`\) | |
| | --------- | ---- | -------- | ----------- | | ||
| | `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.
syntax: Filter example incomplete - missing actual PostgREST syntax example
| | `filter` | string | Yes | PostgREST filter to identify rows to update \(e.g., | | |
| | `filter` | string | Yes | PostgREST filter to identify rows to update \(e.g., `status.eq.pending` or `created_at.lt.2023-01-01`\) | |
| | --------- | ---- | -------- | ----------- | | ||
| | `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) | | ||
| | `table` | string | Yes | The name of the Supabase table to delete from | | ||
| | `filter` | string | Yes | PostgREST filter to identify rows to delete \(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.
syntax: Filter example incomplete - should include actual PostgREST filter syntax
| | `filter` | string | Yes | PostgREST filter to identify rows to delete \(e.g., | | |
| | `filter` | string | Yes | PostgREST filter to identify rows to delete \(e.g., `archived.eq.true` or `last_login.lt.2022-01-01`\) | |
| | `similarLinks` | json | similarLinks output from the block | | ||
| | `answer` | string | answer output from the block | | ||
| | `citations` | json | citations output from the block | | ||
| | `research` | json | research output from the block | |
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 inconsistency: the tool output shows research as string type (line 162), but block configuration shows it as json type. Verify which is correct.
|
|
||
| import { BlockInfoCard } from "@/components/ui/block-info-card" | ||
|
|
||
| <BlockInfoCard |
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: File is in tools/ directory but schedule is categorized as a trigger. Should be in triggers/ directory instead or removed if duplicating existing content.
| > | ||
| <path d='M8 2v4' /> | ||
| <path d='M16 2v4' /> | ||
| <rect x='3' y='4' rx='2' /> |
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.
syntax: SVG rect element missing required width and height attributes
| <rect x='3' y='4' rx='2' /> | |
| <rect width='18' height='18' x='3' y='4' rx='2' /> |
|
|
||
|
|
||
|
|
||
|
|
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: Empty lines serve no purpose and reduce content quality
|
|
||
| | Parameter | Type | Required | Description | | ||
| | --------- | ---- | -------- | ----------- | | ||
| | `scheduleConfig` | schedule-config | Yes | Schedule Status | |
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: Vague description 'Schedule Status' doesn't explain what scheduleConfig parameter does
…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
Type of change
How Has This Been Tested?
NA