fix(docs): fixed docs script to reflect the new output format for all blocks by waleedlatif1 · Pull Request #653 · simstudioai/sim

waleedlatif1 · 2025-07-10T18:55:59Z

fix(docs): fixed tool docs generator script to match new output structure from blocks
updated outdated docs

Description

fixed docs script to reflect the new output format for all blocks, since we got rid of the response wrapper

Type of change

Bug fix (non-breaking change which fixes an issue)
Documentation update

How Has This Been Tested?

Ran the script and ensured that all outputs were not corrupted, but just reflected the new output structure

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added tests that prove my fix is effective or that my feature works
All tests pass locally and in CI (bun run test)
My changes generate no new warnings
Any dependent changes have been merged and published in downstream modules
I have updated version numbers as needed (if needed)
I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Security Considerations:

My changes do not introduce any new security vulnerabilities
I have considered the security implications of my changes

…ture from blocks

vercel · 2025-07-10T18:56:05Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 10, 2025 6:58pm
sim	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 10, 2025 6:58pm

greptile-apps

PR Summary

Extensive documentation update across all tool and block files to remove the 'response' wrapper object from output structures, reflecting a breaking change in the block output format.

Modified scripts/generate-block-docs.ts to handle flat field outputs and improve output extraction with fallback support
Updated 40+ tool documentation files (e.g. apps/docs/content/docs/tools/*.mdx) to directly expose output fields rather than nesting under a 'response' object
Simplified output parameter tables by removing nested '↳' notation and flattening the structure
Added better type inference for generated markdown tables in the documentation generator
Enhanced error handling and logging for documentation output processing

_{54 files reviewed, 22 comments}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-07-10T18:56:27Z

apps/docs/content/docs/tools/jina.mdx

 | Output | Type | Description |
 | ------ | ---- | ----------- |
-| `response` | object | Output from response |
-| ↳ `content` | string | content of the response |
+| `content` | string | content output from the block |


style: The output table's description could be more specific - consider "Raw text content extracted from the target URL"

greptile-apps · 2025-07-10T18:56:28Z

apps/docs/content/docs/tools/typeform.mdx

+| `total_items` | number | total_items output from the block |
+| `page_count` | number | page_count output from the block |
+| `items` | json | items output from the block |


style: improve description formatting consistency - other blocks capitalize first word of descriptions

greptile-apps · 2025-07-10T18:56:28Z

apps/docs/content/docs/tools/tavily.mdx


 | Output | Type | Description |
 | ------ | ---- | ----------- |
-| `response` | object | Output from response |
-| ↳ `results` | json | results of the response |
-| ↳ `answer` | any | answer of the response |
-| ↳ `query` | string | query of the response |
-| ↳ `content` | string | content of the response |
-| ↳ `title` | string | title of the response |
-| ↳ `url` | string | url of the response |
+| `results` | json | results output from the block |
+| `answer` | any | answer output from the block |
+| `query` | string | query output from the block |
+| `content` | string | content output from the block |
+| `title` | string | title output from the block |
+| `url` | string | url output from the block |


style: Missing response type definitions. The output parameter types should be more specific than 'json' and 'any'. Consider defining exact types like string[], object, etc.

greptile-apps · 2025-07-10T18:56:28Z

apps/docs/content/docs/blocks/function.mdx

+- **result**: The value returned by your function
+- **stdout**: Any console output from your function


style: update output fields documentation to include type information (e.g., result: any and stdout: string)

greptile-apps · 2025-07-10T18:56:29Z

apps/docs/content/docs/tools/jira.mdx

+| `description` | string | description output from the block |
+| `created` | string | created output from the block |
+| `updated` | string | updated output from the block |
+| `success` | boolean | success output from the block |


greptile-apps · 2025-07-10T18:56:33Z

apps/docs/content/docs/tools/x.mdx

 | ------ | ---- | ----------- |
-| `response` | object | Output from response |
-| ↳ `tweet` | json | tweet of the response |
-| ↳ `replies` | any | replies of the response |
-| ↳ `context` | any | context of the response |
-| ↳ `tweets` | json | tweets of the response |
-| ↳ `includes` | any | includes of the response |
-| ↳ `meta` | json | meta of the response |
-| ↳ `user` | json | user of the response |
-| ↳ `recentTweets` | any | recentTweets of the response |
+| `tweet` | json | tweet output from the block |
+| `replies` | any | replies output from the block |
+| `context` | any | context output from the block |
+| `tweets` | json | tweets output from the block |
+| `includes` | any | includes output from the block |
+| `meta` | json | meta output from the block |
+| `user` | json | user output from the block |
+| `recentTweets` | any | recentTweets output from the block |


style: Inconsistent type casing. All types should follow consistent casing - either 'JSON' or 'json', 'Any' or 'any'

greptile-apps · 2025-07-10T18:56:33Z

apps/docs/content/docs/tools/google_docs.mdx


 | Output | Type | Description |
 | ------ | ---- | ----------- |
-| `response` | object | Output from response |
-| ↳ `content` | string | content of the response |
-| ↳ `metadata` | json | metadata of the response |
-| ↳ `updatedContent` | boolean | updatedContent of the response |
+| `content` | string | content output from the block |
+| `metadata` | json | metadata output from the block |
+| `updatedContent` | boolean | updatedContent output from the block |


style: Description text should be capitalized for consistency with other fields in the documentation ('content output' -> 'Content output')

greptile-apps · 2025-07-10T18:56:33Z

apps/docs/content/docs/tools/exa.mdx

+| `results` | json | results output from the block |
+| `similarLinks` | json | similarLinks output from the block |
+| `answer` | string | answer output from the block |
+| `citations` | json | citations output from the block |


greptile-apps · 2025-07-10T18:56:33Z

apps/docs/content/docs/tools/x.mdx

+| `tweet` | json | tweet output from the block |
+| `replies` | any | replies output from the block |
+| `context` | any | context output from the block |
+| `tweets` | json | tweets output from the block |
+| `includes` | any | includes output from the block |
+| `meta` | json | meta output from the block |
+| `user` | json | user output from the block |
+| `recentTweets` | any | recentTweets output from the block |


style: Output descriptions are generic and not descriptive enough. Add specific details about what each field contains

greptile-apps · 2025-07-10T18:56:34Z

apps/docs/content/docs/tools/gmail.mdx

 | ------ | ---- | ----------- |
-| `response` | object | Output from response |
-| ↳ `content` | string | content of the response |
-| ↳ `metadata` | json | metadata of the response |
+| `content` | string | content output from the block |
+| `metadata` | json | metadata output from the block |


style: output parameter descriptions should be capitalized and end with periods to match style of input parameter descriptions above

delve-auditor · 2025-07-10T18:56:56Z

✅ No security or compliance issues detected. Reviewed everything up to 7e97a7c.

Security Overview

🔎 Scanned files: 55 changed file(s)

Detected Code Changes

Change Type	Relevant files
Documentation	► function.mdx Update output field documentation ► response.mdx Simplify response output documentation ► airtable.mdx Update output fields format ► autoblocks.mdx Update output fields format ► browser_use.mdx Update output fields format ► clay.mdx Update output fields format ► confluence.mdx Update output fields format ► discord.mdx Update output fields format

Reply to this PR with @delve-auditor followed by a description of what change you want and we'll auto-submit a change to this PR to implement it.

… blocks (simstudioai#653) * fix(docs): fixed tool docs generator script to match new output structure from blocks * updated outdated docs

waleedlatif1 added 2 commits July 10, 2025 11:43

fix(docs): fixed tool docs generator script to match new output struc…

1456eab

…ture from blocks

updated outdated docs

7e97a7c

greptile-apps bot reviewed Jul 10, 2025

View reviewed changes

vercel bot deployed to Preview – sim July 10, 2025 18:58 View deployment

waleedlatif1 merged commit 30538d9 into staging Jul 10, 2025
6 checks passed

waleedlatif1 mentioned this pull request Jul 10, 2025

v0.2.11: fix + feat + improvement #657

Merged

waleedlatif1 deleted the fix/docs-script branch July 10, 2025 22:24

		- result: The value returned by your function
		- stdout: Any console output from your function

	\| `success` \| boolean \| success output from the block \|
	\| `success` \| string \| success output from the block \|

Conversation

waleedlatif1 commented Jul 10, 2025

Description

Type of change

How Has This Been Tested?

Checklist:

Security Considerations:

Uh oh!

vercel bot commented Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

delve-auditor bot commented Jul 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vercel bot commented Jul 10, 2025 •

edited

Loading