Implemented workflow tab and updated node descriptions#6
Implemented workflow tab and updated node descriptions#6vaibhav-kawa wants to merge 5 commits intoWorqHat:mainfrom
Conversation
The changes address a grammatical issue in the Email-Trigger.mdx file, enhancing clarity and readability by ensuring correct sentence structure. * Email-Trigger.mdx: Fixed a grammatical error for better readability.
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughA comprehensive set of new workflow node documentation files was added across AI-Nodes, Database, Process-Nodes, Triggers, and Utility categories, and docs.json was updated to add a top-level "Workflow" tab with grouped navigation entries. Changes
Sequence Diagram(s)sequenceDiagram
participant Trigger as Trigger (e.g., REST / Email)
participant Process as Process Nodes (If/For/Switch/Loop)
participant AI as AI Nodes (Text/Image/Moderation)
participant Util as Utility Nodes (HTTP, Calendar, SMS, etc.)
participant Return as Return State
Note over Trigger,Process: Workflow start (event)
Trigger->>Process: pass input payload
alt Conditional branching
Process->>AI: route to Text-Generation / Image-Analysis
AI-->>Process: output (content, metadata)
else Loop / Repeat
Process->>Util: call HTTP/DB/Calendar per iteration
Util-->>Process: per-iteration result
end
Process->>Return: aggregate final JSON
Return-->>Trigger: end workflow (response / final output)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 15
🧹 Nitpick comments (21)
Workflow/Utility/Google-Maps.mdx (1)
128-131: Minor grammar improvement: Rephrase the double modal.Line 130 uses "requires input" which is nonstandard. Consider rephrasing to: "If your selected option needs input" or "If your selected option requires specific data".
Workflow/Utility/Handle-Variable.mdx (2)
23-25: Consider reducing phrase repetition for better flow.Lines 24 and 5 both use "want to" in close proximity. Rephrase line 24 to vary the language: "Enter the value you wish to store in this variable" or "Enter the value to store in this variable".
74-74: Use "brief" instead of "short" for stronger technical writing.Line 74: "Optionally, write a brief description" conveys precision better than "short description" in technical documentation.
Workflow/Utility/Web-Search.mdx (1)
49-53: Vary list structure to reduce successive repetition.Lines 49-53 show output parameter fields starting with the same pattern. Consider consolidating related fields into a table or paragraph format for better readability:
The **results[]** array contains: - **title** — Title of the web page or article - **url** — Direct link to the web page - **snippet** — A short excerpt from page content - **date** — Original publication date (if available) - **last_updated** — Last modified or indexed dateThis maintains clarity while reducing structural repetition.
Workflow/Utility/Calendar-Fetch-Events.mdx (1)
254-254: Use "brief" instead of "short" for consistency in technical documentation.Line 254: "Summarizes the fetched events into a brief message" is more precise and professional than "short message".
Workflow/Triggers/Time-Based-Runs.mdx (2)
1-12: Review grammar and style consistency throughout the document.The static analysis flagged several issues to address:
- Line 8: Use hyphen in "Time-Based Runs" to match title format
- Lines 128 & 145: Three consecutive sentences begin with "Use" — consider rewording for variation
Apply these fixes:
-The **Time Based Runs (Time Trigger)** node allows you to automatically start workflows +The **Time-Based Runs (Time Trigger)** node allows you to automatically start workflowsFor lines 128–145, consider revising the Best Practices section:
## Best Practices * Use **interval** for simple repeat tasks (e.g., every few minutes or hours). - * Use **natural_description** for readability in business or team workflows. - * Use **cron_description** for complex or system-level automation. + * Prefer **natural_description** for readability in business or team workflows. + * Consider **cron_description** for complex or system-level automation.
52-67: Minor redundancy in Output Parameters section.Lines 54–67 contain some redundant explanation across three subsections (Output Parameters, Output Type, Output Parameters Instructions). Consider consolidating for brevity.
The output type and parameter sections could be more concise:
## Output Parameters This node does **not** produce outputs. It is purely a **trigger** — its role is to initiate workflow execution based on time conditions. - **Output Parameters:** N/A - **Instructions:** No outputs are exposed to downstream nodes. - --- - ## Output Type - **Output Type:** N/A - This node does not generate any data output; it only triggers workflow execution.Workflow/AI-Nodes/Content-Moderation.mdx (1)
62-94: Consolidate duplicate instructions sections.Lines 62–75 and 79–94 both labeled "Instructions" contain overlapping information. Consolidate to avoid redundancy.
Combine these sections:
**Instructions:** - Provide all parameters as flat key-value pairs. - For multiple files, use comma-separated values such as: - - ``` - file1.jpg,file2.jpg - {{nodeId.output.file1}},{{nodeId.output.file2}} - ``` - - Access input values dynamically within the workflow using: - - ``` - {{nodeId.input.<key>}} - ``` - - --- - - **Instructions:** Provide all input parameters as flat key-value pairs. For multiple file inputs, separate file IDs or variable references with commas. Example:file1.jpg,file2.jpg
{{nodeId.output.file1}},{{nodeId.output.file2}}Access input values within the workflow using:{{nodeId.input.}}
Workflow/Utility/send-mail.mdx (1)
34-35: Fix incomplete sentence in CC parameter description.Line 35 is missing a subject to form a complete sentence.
Revise for grammatical completeness:
* **cc:** - Optional email addresses to send a carbon copy to. Can be a single address or multiple ones separated by commas. *(Optional)* + Optional email addresses to send a carbon copy to—single or multiple addresses separated by commas. *(Optional)*Workflow/Process-Nodes/return-state.mdx (1)
185-191: Minor: Summary section may be redundant.The final Summary section (lines 185–191) largely recaps the Overview. Consider whether this adds value or can be removed for conciseness.
The Summary repeats content from the Overview section. For conciseness, consider removing it or merging its unique insights into the Overview.
Workflow/Utility/Http-Request.mdx (1)
27-50: Fix formatting inconsistency and redundant text in input parameters.Lines 27–50 use a different format than the rest of the file. Parameters lack proper markdown table formatting, and some entries have redundant "Required: No" labels.
Restructure input parameters for consistency and clarity. Consider using a markdown table or bullet-list format matching other files in this PR:
- **endpointUrl (String)** - Complete API endpoint - Example: `https://jsonplaceholder.typicode.com/posts` - Required: Yes - - **method (String)** - Supported: GET, POST, PUT, DELETE - Required: Yes - - **authType (String)** - Authentication type: None / Basic / Bearer - Required: No - - **token (String)** - Bearer token if needed - Required: No +**endpointUrl** (String, Required) + Complete API endpoint. Example: `https://jsonplaceholder.typicode.com/posts` + +**method** (String, Required) + Supported methods: GET, POST, PUT, DELETE + +**authType** (String, Optional) + Authentication type: None, Basic, or BearerWorkflow/Triggers/File-Upload-Trigger.mdx (1)
153-161: Approve documentation with minor style suggestion.The File Upload Trigger documentation is clear and comprehensive. It effectively explains file-based workflow triggers with practical examples. One minor style note: Line 159 uses "extremely" as an intensifier.
Consider replacing the over-used intensifier "extremely" on line 159:
- * Avoid attaching extremely large files to prevent delays or timeouts. + * Avoid attaching large files to prevent delays or timeouts.Workflow/Process-Nodes/for-loop.mdx (1)
101-118: Minor style improvements for readability.The static analysis tool flagged two style preferences:
- Line 104-108: Consecutive steps starting with "Set" can be reworded for variety.
- Line 115: Consider replacing the weak intensifier "very" with a stronger alternative.
These are optional improvements for polish.
- 2. Set the start value. - 3. Set the end value. - 4. Set step if needed. + 2. Define the start value. + 3. Define the end value. + 4. Configure the step (if needed). - • Avoid very large end values to prevent performance issues. + • Avoid excessively large end values to prevent performance issues.Workflow/Process-Nodes/Switch-case.mdx (1)
21-26: Optional: Vary sentence structure in conditional explanation.The three consecutive bullet points (lines 21-25) all start with "If", which helps convey the conditional logic but could be restructured for variety.
- * If the input is "1", the workflow can proceed to an "Add Data" node. - * If the input is "2", it can proceed to a "Delete Data" node. - * If the input does not match any case, it will follow the default branch and return a fallback response. + * Input "1" → workflow proceeds to "Add Data" node. + * Input "2" → workflow proceeds to "Delete Data" node. + * Unmatched input → workflow follows default branch and returns fallback response.Workflow/Database/update-data.mdx (1)
25-35: Optional: Clarify repetitive phrasing in parameter description.Line 29 states "It's used as both a query and data input" which could be clearer.
- * **id** – The unique identifier of the record you want to update. It's used as both a query and data input. + * **id** – The unique identifier of the record to update (used to locate the record and included in the update).Workflow/Database/query-data.mdx (1)
56-62: Optional: Strengthen wording in parameter descriptions.The static analysis tool suggested two minor refinements:
- Line 58: Vary phrasing for "how many records you want to retrieve."
- Line 231: Strengthen the phrasal verb "left out" to a more direct term.
- * **Limit:** - Specify how many records you want to retrieve at most. + * **Limit:** + Set the maximum number of records to return. - * **Missing required field:** - You might have left out a necessary input or not connected upstream nodes correctly. + * **Missing required field:** + A necessary input was omitted or upstream nodes weren't connected correctly.Workflow/Database/fetch-data.mdx (1)
1-271: Well-structured documentation with clear examples and comprehensive coverage.The documentation effectively explains the Fetch Data node with practical examples, clear input/output descriptions, and helpful integration patterns. The JSON examples are realistic and guide users effectively.
One minor style note: Line 15 contains a split infinitive ("automatically pull"). Consider restructuring to "pull text and metadata automatically" for clarity, though this is a low-priority refinement.
Workflow/AI-Nodes/Text-Extraction.mdx (1)
1-320: Comprehensive documentation with clear extraction type differentiation and thorough output field documentation.The Text Extraction node documentation effectively covers all four extraction modes (PDF, web, image, audio) with appropriate output structures for each. The example outputs are realistic and helpful, particularly the audio transcription example showing speaker labels and timestamps.
Minor style suggestions from LanguageTool (lines 15):
- Consider restructuring "designed to automatically pull" to "designed to pull...automatically"
- Replace "variety of" with "range of" or simply list formats directly
These are optional refinements that do not impact clarity.
Workflow/Database/add-new-data.mdx (1)
1-200: Clear documentation with particularly helpful error handling examples.The Add New Data node documentation effectively explains the insertion process, input validation, and error scenarios. Example 2 (Missing Required Field) is especially valuable as it shows users what to expect when validation fails, including error types and codes.
Minor style note from LanguageTool: Lines 9 and 35 use "records" which could be simplified to "data" or "items" in some contexts, though current wording is acceptable and clear.
Workflow/Database/create-graphs.mdx (1)
1-214: Comprehensive documentation with good coverage of both structured and natural language query approaches.The Create Graphs node documentation effectively explains visualization options across five chart types and two query methods (structured and natural language). The examples clearly demonstrate both approaches, and best practices appropriately warn about dataset size limitations and field type requirements.
Minor style notes from LanguageTool (optional refinements):
- Line 35: "want to use" is repeated; consider varying with "need" or "require"
- Line 163: "short description" could use "brief description" for variety
No critical issues.
Workflow/Process-Nodes/if-else-condition.mdx (1)
1-200: Well-structured documentation with effective use of tables and comprehensive examples.The If/Else Condition node documentation is clear and well-organized, with effective use of parameter tables and practical examples. The error table at the end is particularly helpful for troubleshooting. The best practices section appropriately emphasizes testing both True and False paths.
Minor style suggestions from LanguageTool (optional refinements):
- Line 92: "User Name" could be written as "username" for compound consistency
- Line 138: "value you want to compare against" is repeated in line 143; vary the phrasing
- Lines 140-143: Three bullet points beginning with "Connect" and "If" could vary opening words
No critical issues.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (34)
Workflow/AI-Nodes/Content-Moderation.mdx(1 hunks)Workflow/AI-Nodes/Image-analysis.mdx(1 hunks)Workflow/AI-Nodes/Image-generation.mdx(1 hunks)Workflow/AI-Nodes/Text-Extraction.mdx(1 hunks)Workflow/AI-Nodes/Text-Generation.mdx(1 hunks)Workflow/AI-Nodes/Text-to-speech.mdx(1 hunks)Workflow/Database/add-new-data.mdx(1 hunks)Workflow/Database/create-graphs.mdx(1 hunks)Workflow/Database/delete-data.mdx(1 hunks)Workflow/Database/fetch-data.mdx(1 hunks)Workflow/Database/query-data.mdx(1 hunks)Workflow/Database/update-data.mdx(1 hunks)Workflow/Process-Nodes/Loop-process.mdx(1 hunks)Workflow/Process-Nodes/Switch-case.mdx(1 hunks)Workflow/Process-Nodes/for-loop.mdx(1 hunks)Workflow/Process-Nodes/if-else-condition.mdx(1 hunks)Workflow/Process-Nodes/return-state.mdx(1 hunks)Workflow/Triggers/Email-Trigger.mdx(1 hunks)Workflow/Triggers/File-Upload-Trigger.mdx(1 hunks)Workflow/Triggers/Rest-Api-Trigger.mdx(1 hunks)Workflow/Triggers/Time-Based-Runs.mdx(1 hunks)Workflow/Triggers/Whatsapp-trigger.mdx(1 hunks)Workflow/Utility/Calendar-Add-Event.mdx(1 hunks)Workflow/Utility/Calendar-Fetch-Events.mdx(1 hunks)Workflow/Utility/Custom-Node.mdx(1 hunks)Workflow/Utility/Google-Maps.mdx(1 hunks)Workflow/Utility/HTML-PDF.mdx(1 hunks)Workflow/Utility/Handle-Variable.mdx(1 hunks)Workflow/Utility/Http-Request.mdx(1 hunks)Workflow/Utility/Send-Sms-Using-Plivo.mdx(1 hunks)Workflow/Utility/Send-WhatsApp.mdx(1 hunks)Workflow/Utility/Web-Search.mdx(1 hunks)Workflow/Utility/send-mail.mdx(1 hunks)docs.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
Workflow/Utility/Calendar-Fetch-Events.mdx
[style] ~254-~254: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ...n (Summarizes the fetched events into a short message.) 4. Utility Node: Slack Me...
(QUICK_BRIEF)
Workflow/Utility/Web-Search.mdx
[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...)* — Direct link to the web page. * results[].snippet (string) — A short excerp...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~52-~52: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...escription from the page content. * results[].date (string) — The original publ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...te of the content (if available). * results[].last_updated (string) — The last ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Workflow/Database/update-data.mdx
[style] ~29-~29: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...The unique identifier of the record you want to update. It’s used as both a query and d...
(REP_WANT_TO_VB)
Workflow/Process-Nodes/Switch-case.mdx
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... can proceed to a “Delete Data” node. * If the input does not match any case, it w...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Workflow/Database/query-data.mdx
[style] ~58-~58: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Limit:** Specify how many records you want to retrieve at most. * **Start After / Of...
(REP_WANT_TO_VB)
[style] ~231-~231: To strengthen your wording, consider replacing the phrasal verb “leave out”.
Context: ...sing required field:** You might have left out a necessary input or not connected upst...
(OMIT_EXCLUDE)
Workflow/AI-Nodes/Text-Extraction.mdx
[style] ~15-~15: Try moving the adverb to make the sentence clearer.
Context: ...low. --- ## Description This node is designed to automatically pull text and metadata from a variety of input formats — inclu...
(SPLIT_INFINITIVE)
[style] ~15-~15: Consider using a more concise synonym.
Context: ...tomatically pull text and metadata from a variety of input formats — including **documents, ...
(A_VARIETY_OF)
Workflow/Process-Nodes/return-state.mdx
[style] ~26-~26: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ...0 for success). * message – gives a short description of the result. * data –...
(QUICK_BRIEF)
Workflow/Database/add-new-data.mdx
[style] ~9-~9: ‘new records’ might be wordy. Consider a shorter alternative.
Context: ...dd New Data** node allows you to insert new records into your existing database tables or c...
(EN_WORDINESS_PREMIUM_NEW_RECORDS)
[style] ~35-~35: ‘new record’ might be wordy. Consider a shorter alternative.
Context: ...for these parameters to insert into the new record. Example: ```json { "name": ...
(EN_WORDINESS_PREMIUM_NEW_RECORD)
Workflow/Triggers/Time-Based-Runs.mdx
[grammar] ~8-~8: Use a hyphen to join words.
Context: ...Time-Based --- ## Overview The Time Based Runs (Time Trigger) node allows ...
(QB_NEW_EN_HYPHEN)
[style] ~128-~128: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...edules (e.g., “every day at 9am”). * Use cron_description for advanced timin...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~145-~145: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...bility in business or team workflows. * Use cron_description for complex or sys...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Workflow/Triggers/File-Upload-Trigger.mdx
[style] ~159-~159: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ... in larger workflows. * Avoid attaching extremely large files to prevent delays or timeouts. * ...
(EN_WEAK_ADJECTIVE)
Workflow/Database/create-graphs.mdx
[style] ~35-~35: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...of the database table or collection you want to use (for example, test3 (production))...
(REP_WANT_TO_VB)
[style] ~163-~163: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ...2. Open Node Settings and give it a short description (optional). 3. Select the *...
(QUICK_BRIEF)
Workflow/Utility/Http-Request.mdx
[style] ~41-~41: The double modal “needed Required” is nonstandard (only accepted in certain dialects). Consider “to be Required”.
Context: ...token (String)** Bearer token if needed Required: No username (String) Used with Ba...
(NEEDS_FIXED)
[grammar] ~75-~75: Use a hyphen to join words.
Context: ...odedData (Array)** Used when sending URL encoded data headers (Array) Exampl...
(QB_NEW_EN_HYPHEN)
[style] ~176-~176: ‘new record’ might be wordy. Consider a shorter alternative.
Context: ...data → HTTP Request Node 3. API returns new record 4. Response ID passed to next node ## ...
(EN_WORDINESS_PREMIUM_NEW_RECORD)
Workflow/Utility/Handle-Variable.mdx
[style] ~24-~24: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Variable Value: Enter the value you want to store inside the variable. It can be a ...
(REP_WANT_TO_VB)
[style] ~74-~74: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ...u want to store. 5. Optionally, write a short description. 6. Save changes and connec...
(QUICK_BRIEF)
Workflow/Utility/send-mail.mdx
[style] ~35-~35: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...ail addresses to send a carbon copy to. Can be a single address or multiple ones se...
(MISSING_IT_THERE)
Workflow/Process-Nodes/if-else-condition.mdx
[style] ~92-~92: It’s more common nowadays to write this noun as one word.
Context: ... branch**. --- ### Example 2: Match a User Name Input: ```json { "sourceNode": ...
(RECOMMENDED_COMPOUNDS)
[style] ~138-~138: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Set a Value Enter the value you want to compare against. 6. **Connect the True...
(REP_WANT_TO_VB)
[style] ~143-~143: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... you want if the condition is met. * Connect the False path to the action you wa...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Workflow/Utility/Google-Maps.mdx
[style] ~130-~130: The double modal “requires input” is nonstandard (only accepted in certain dialects). Consider “to be input”.
Context: ... * If your selected option requires input (like addresses or coordinates), use pr...
(NEEDS_FIXED)
Workflow/Process-Nodes/for-loop.mdx
[style] ~104-~104: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e start value. 3. Set the end value. 4. Set step if needed. 5. Place one or more no...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~115-~115: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... Test with a small range first. • Avoid very large end values to prevent performance issue...
(EN_WEAK_ADJECTIVE)
🔇 Additional comments (13)
Workflow/Process-Nodes/Loop-process.mdx (1)
1-202: LGTM!Comprehensive and well-structured documentation with clear examples, practical best practices, and helpful error guidance. The content appropriately explains control flow concepts in accessible language for no-code users.
Workflow/Utility/Send-WhatsApp.mdx (1)
1-123: LGTM!Clear, practical documentation covering Twilio WhatsApp integration with appropriate examples and error guidance. Input parameters and best practices are well-defined for users implementing this node.
Workflow/Triggers/Whatsapp-trigger.mdx (1)
1-154: LGTM!Well-structured trigger documentation with clear examples for both text and media messages. The explanation of auto-populated webhook fields and practical best practices (e.g., checking for file field before processing) are helpful for users implementing WhatsApp-triggered workflows.
Workflow/Utility/Custom-Node.mdx (1)
1-226: LGTM!Excellent documentation for the Custom Node with practical examples in both JavaScript and Python. Best practices section appropriately emphasizes error handling, input validation, and testing before production deployment. The workflow integration example clearly demonstrates how custom logic fits into a larger automation pipeline.
Workflow/Process-Nodes/return-state.mdx (1)
1-50: Approve documentation structure and content.This file provides clear, beginner-friendly documentation of the Return State Node. The structure effectively explains this node as the final workflow step and maintains consistency with other workflow node documentation patterns.
Workflow/Utility/Send-Sms-Using-Plivo.mdx (1)
1-50: Approve comprehensive documentation with clear prerequisites.This file excellently documents the Send SMS using Plivo node with clear prerequisites, well-structured input/output parameters, and realistic examples. The emphasis on Plivo-specific requirements (DLT provider, sender ID registration) is helpful for users.
Workflow/Triggers/Email-Trigger.mdx (1)
1-15: Approve overall structure and content quality.The Email Trigger documentation is comprehensive and well-organized. It effectively explains the unique email address generation, parameter access patterns, and provides clear examples. The emphasis on the
GENERATE_INCOMING_EMAILmacro and usage patterns is helpful for users.Workflow/AI-Nodes/Text-Generation.mdx (1)
1-282: Comprehensive documentation with clear examples. ✓The Text Generation Node documentation is well-structured and complete. Input parameters are clearly defined, JSON schema constraints are explicitly stated (line 78), and two practical examples demonstrate both text and JSON output modes. The best practices align with realistic usage patterns.
Workflow/AI-Nodes/Text-to-speech.mdx (1)
1-197: Well-structured audio node documentation. ✓The Text-to-Speech documentation is clear and complete, with practical examples showing both static input and variable references. The voice ID list and example workflow integration help users get started quickly.
Workflow/Utility/HTML-PDF.mdx (1)
1-145: Clear file conversion documentation. ✓The HTML-to-PDF node documentation is comprehensive with practical examples including realistic file URLs and timestamps. The best practices emphasize important constraints (external resources, HTML structure) that users need to understand.
Workflow/Triggers/Rest-Api-Trigger.mdx (1)
1-215: Comprehensive trigger documentation with practical examples. ✓The REST API Trigger documentation correctly explains that this is an entry point with no separate output variables. The distinction between input exposure and output parameters is clearly made (lines 79-95), and examples show both JSON body and query parameter approaches. Best practices appropriately include security guidance.
Workflow/Database/delete-data.mdx (1)
1-150: Excellent documentation with appropriate emphasis on safety practices.The Delete Data node documentation is well-written with clear warnings and best practices for destructive operations. The "Best Practices" section appropriately emphasizes using unique conditions and testing in staging environments before production use. Examples are concrete and the common error section is helpful.
No issues identified.
Workflow/Utility/Calendar-Add-Event.mdx (1)
1-271: Professional and thorough documentation with clear Google Meet integration guidance.The Calendar Add Event node documentation is well-organized with practical examples covering both virtual (Google Meet) and in-person scenarios. The best practices section appropriately emphasizes timezone accuracy and permission validation. Output parameters are clearly explained and error cases are well-documented.
No issues identified.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
17 issues found across 34 files
Prompt for AI agents (all 17 issues)
Understand the root cause of the following 17 issues and fix them.
<file name="Workflow/Utility/Calendar-Fetch-Events.mdx">
<violation number="1" location="Workflow/Utility/Calendar-Fetch-Events.mdx:157">
`totalEvents` should match the number of sample events. Please either add the missing third event or adjust `totalEvents` to 2 for consistency.</violation>
</file>
<file name="Workflow/Utility/Send-Sms-Using-Plivo.mdx">
<violation number="1" location="Workflow/Utility/Send-Sms-Using-Plivo.mdx:43">
Plivo supports SMS bodies longer than 160 characters (they are segmented automatically), so this line incorrectly states a hard 160-character limit.</violation>
</file>
<file name="Workflow/AI-Nodes/Content-Moderation.mdx">
<violation number="1" location="Workflow/AI-Nodes/Content-Moderation.mdx:169">
Example 1’s expected output has an extra opening brace, leaving the JSON malformed. Please remove the redundant brace pair so the sample is valid JSON.</violation>
<violation number="2" location="Workflow/AI-Nodes/Content-Moderation.mdx:171">
The Example 1 request JSON includes a trailing comma after the last field, making the sample invalid JSON. Please drop the trailing comma so the snippet can be copied directly into tools without syntax errors.</violation>
<violation number="3" location="Workflow/AI-Nodes/Content-Moderation.mdx:182">
Example 1 lists `flaggedCategories` as an array, but the Output Parameters section defines it as a comma-separated string. Please align the example with the documented type.</violation>
</file>
<file name="Workflow/Database/update-data.mdx">
<violation number="1" location="Workflow/Database/update-data.mdx:79">
The example illustrates updating a record, but the sample output still reports `updatedCount` 0 and "Successfully updated 0 record(s)", which contradicts the described scenario. Please update the example to reflect a successful record update so the docs match expected behavior.</violation>
</file>
<file name="Workflow/AI-Nodes/Image-generation.mdx">
<violation number="1" location="Workflow/AI-Nodes/Image-generation.mdx:121">
The sample JSON under **Example Usage** is invalid because the `"prompt"` value opens a string with `{` and then introduces unescaped quotes plus a nested object before closing, so anyone copying it will hit parse errors. Please correct the example to valid JSON.</violation>
</file>
<file name="Workflow/AI-Nodes/Image-analysis.mdx">
<violation number="1" location="Workflow/AI-Nodes/Image-analysis.mdx:122">
The Example 1 output includes an extra opening brace, so the sample JSON is malformed and will fail if readers copy it directly.</violation>
<violation number="2" location="Workflow/AI-Nodes/Image-analysis.mdx:154">
The Face Detection example asks about a building even though the accompanying output enumerates facial attributes, which misleads readers about how to query this node.</violation>
</file>
<file name="Workflow/Utility/Calendar-Add-Event.mdx">
<violation number="1" location="Workflow/Utility/Calendar-Add-Event.mdx:158">
The example output contradicts the earlier note that `processingTime` is returned in ISO duration format. Please update the sample to use a valid ISO 8601 duration (e.g., `PT2S`).</violation>
</file>
<file name="Workflow/AI-Nodes/Text-Generation.mdx">
<violation number="1" location="Workflow/AI-Nodes/Text-Generation.mdx:115">
`processingTime` is described as returning an ISO timestamp, but the example shows it returns a numeric duration (e.g., 5178). Please update the description to match the actual output format to avoid misleading users.</violation>
</file>
<file name="Workflow/Database/create-graphs.mdx">
<violation number="1" location="Workflow/Database/create-graphs.mdx:89">
Example 1 configures `yField` to `active`, but the sample data returns the string value "yes", so a line graph can't plot this output. Please update the example to use a numeric field for `yField` so the chart configuration is valid.</violation>
</file>
<file name="Workflow/Database/query-data.mdx">
<violation number="1" location="Workflow/Database/query-data.mdx:138">
The expected output message claims 13 documents, but the data array only shows two records, so the example is inconsistent and misleading. Please align the message with the sample data.</violation>
</file>
<file name="Workflow/AI-Nodes/Text-Extraction.mdx">
<violation number="1" location="Workflow/AI-Nodes/Text-Extraction.mdx:203">
Update this example to show `processingTime` as an ISO-formatted timestamp so it is consistent with the documented output description.</violation>
<violation number="2" location="Workflow/AI-Nodes/Text-Extraction.mdx:224">
Example 3 should not wrap the response in an `output` object because the documented outputs are top-level fields. Please remove that wrapper so the payload shape matches the rest of the documentation.</violation>
<violation number="3" location="Workflow/AI-Nodes/Text-Extraction.mdx:226">
`processingTime` should follow the documented ISO timestamp format; please replace the numeric value with an ISO-formatted string so the example matches the description.</violation>
</file>
<file name="Workflow/AI-Nodes/Text-to-speech.mdx">
<violation number="1" location="Workflow/AI-Nodes/Text-to-speech.mdx:173">
Remove the meta-instructional sentence so the Common Errors section reads like end-user documentation rather than editing notes.</violation>
</file>
React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.
|
|
||
| ```json | ||
| { | ||
| "totalEvents": 3, |
There was a problem hiding this comment.
totalEvents should match the number of sample events. Please either add the missing third event or adjust totalEvents to 2 for consistency.
Prompt for AI agents
Address the following comment on Workflow/Utility/Calendar-Fetch-Events.mdx at line 157:
<comment>`totalEvents` should match the number of sample events. Please either add the missing third event or adjust `totalEvents` to 2 for consistency.</comment>
<file context>
@@ -0,0 +1,275 @@
+
+```json
+{
+ "totalEvents": 3,
+ "timezone": "Asia/Kolkata",
+ "events": [
</file context>
| "totalEvents": 3, | |
| "totalEvents": 2, |
✅ Addressed in abef802
|
|
||
| * **message** | ||
| The actual text message you want to send. | ||
| The content must not exceed **160 characters** per message. |
There was a problem hiding this comment.
Plivo supports SMS bodies longer than 160 characters (they are segmented automatically), so this line incorrectly states a hard 160-character limit.
Prompt for AI agents
Address the following comment on Workflow/Utility/Send-Sms-Using-Plivo.mdx at line 43:
<comment>Plivo supports SMS bodies longer than 160 characters (they are segmented automatically), so this line incorrectly states a hard 160-character limit.</comment>
<file context>
@@ -0,0 +1,222 @@
+
+* **message**
+ The actual text message you want to send.
+ The content must not exceed **160 characters** per message.
+ Example: `"Your OTP code is 472916. It will expire in 5 minutes."`
+
</file context>
| The content must not exceed **160 characters** per message. | |
| Messages longer than **160 characters** are automatically split into multiple segments before sending. |
✅ Addressed in abef802
| { | ||
| "output": { | ||
| "flagged": true, | ||
| "flaggedCategories": [ |
There was a problem hiding this comment.
Example 1 lists flaggedCategories as an array, but the Output Parameters section defines it as a comma-separated string. Please align the example with the documented type.
Prompt for AI agents
Address the following comment on Workflow/AI-Nodes/Content-Moderation.mdx at line 182:
<comment>Example 1 lists `flaggedCategories` as an array, but the Output Parameters section defines it as a comma-separated string. Please align the example with the documented type.</comment>
<file context>
@@ -0,0 +1,321 @@
+ {
+ "output": {
+ "flagged": true,
+ "flaggedCategories": [
+ "harassment"
+ ],
</file context>
| ### Example 1: Text Moderation | ||
|
|
||
| ```json | ||
| { |
There was a problem hiding this comment.
Example 1’s expected output has an extra opening brace, leaving the JSON malformed. Please remove the redundant brace pair so the sample is valid JSON.
Prompt for AI agents
Address the following comment on Workflow/AI-Nodes/Content-Moderation.mdx at line 169:
<comment>Example 1’s expected output has an extra opening brace, leaving the JSON malformed. Please remove the redundant brace pair so the sample is valid JSON.</comment>
<file context>
@@ -0,0 +1,321 @@
+### Example 1: Text Moderation
+
+```json
+{
+ "moderationType": "text-moderation",
+ "moderationText": "I hate you!",
</file context>
✅ Addressed in abef802
Workflow/Database/query-data.mdx
Outdated
| "status": null | ||
| } | ||
| ], | ||
| "message": "Successfully fetched 13 documents", |
There was a problem hiding this comment.
The expected output message claims 13 documents, but the data array only shows two records, so the example is inconsistent and misleading. Please align the message with the sample data.
Prompt for AI agents
Address the following comment on Workflow/Database/query-data.mdx at line 138:
<comment>The expected output message claims 13 documents, but the data array only shows two records, so the example is inconsistent and misleading. Please align the message with the sample data.</comment>
<file context>
@@ -0,0 +1,240 @@
+ "status": null
+ }
+ ],
+ "message": "Successfully fetched 13 documents",
+ "status": "success"
+ }
</file context>
| "message": "Successfully fetched 13 documents", | |
| "message": "Successfully fetched 2 documents", |
✅ Addressed in abef802
| ```json | ||
| { | ||
| "content": "Here is the article content extracted from the page...", | ||
| "processingTime": "0.471", |
There was a problem hiding this comment.
Update this example to show processingTime as an ISO-formatted timestamp so it is consistent with the documented output description.
Prompt for AI agents
Address the following comment on Workflow/AI-Nodes/Text-Extraction.mdx at line 203:
<comment>Update this example to show `processingTime` as an ISO-formatted timestamp so it is consistent with the documented output description.</comment>
<file context>
@@ -0,0 +1,320 @@
+```json
+{
+ "content": "Here is the article content extracted from the page...",
+ "processingTime": "0.471",
+ "processingId": "mistral-ocr-1761738927697",
+ "processingCount": 41
</file context>
| "processingTime": "0.471", | |
| "processingTime": "2025-10-27T12:06:11Z", |
✅ Addressed in abef802
| { | ||
| "output": { | ||
| "content": "The evening sky was painted with shades of orange and violet. As the city slowly settled into its nightly rhythm. Streetlights flickered to life, casting warm pools of light on the sidewalks where people hurried home, their faces half hidden behind scarves and tired smiles. Somewhere, a musician played a soft tune on a saxophone, its notes drifting between buildings like fragments of a forgotten dream. In the distance, the sound of traffic blended with laughter spilling out of a nearby cafe. Inside, a, uh, writer sat alone with a cup of coffee gone cold, his laptop open but untouched. He watched the rain begin to fall against the window, tracing patterns that matched the rhythm of his thoughts. Every drop felt like a reminder that even in a crowded city, moments of stillness could be found in the smallest details. A quiet song, a stranger's laughter, or the glow of street lights reflecting on wet pavement. And in that quiet, he finally began to type M. Not to impress anyone or chase perfection, but simply to capture the fleeting beauty of the world as he saw it.", | ||
| "processingTime": 28611.279511, |
There was a problem hiding this comment.
processingTime should follow the documented ISO timestamp format; please replace the numeric value with an ISO-formatted string so the example matches the description.
Prompt for AI agents
Address the following comment on Workflow/AI-Nodes/Text-Extraction.mdx at line 226:
<comment>`processingTime` should follow the documented ISO timestamp format; please replace the numeric value with an ISO-formatted string so the example matches the description.</comment>
<file context>
@@ -0,0 +1,320 @@
+{
+ "output": {
+ "content": "The evening sky was painted with shades of orange and violet. As the city slowly settled into its nightly rhythm. Streetlights flickered to life, casting warm pools of light on the sidewalks where people hurried home, their faces half hidden behind scarves and tired smiles. Somewhere, a musician played a soft tune on a saxophone, its notes drifting between buildings like fragments of a forgotten dream. In the distance, the sound of traffic blended with laughter spilling out of a nearby cafe. Inside, a, uh, writer sat alone with a cup of coffee gone cold, his laptop open but untouched. He watched the rain begin to fall against the window, tracing patterns that matched the rhythm of his thoughts. Every drop felt like a reminder that even in a crowded city, moments of stillness could be found in the smallest details. A quiet song, a stranger's laughter, or the glow of street lights reflecting on wet pavement. And in that quiet, he finally began to type M. Not to impress anyone or chase perfection, but simply to capture the fleeting beauty of the world as he saw it.",
+ "processingTime": 28611.279511,
+ "processingId": "dc9509af-3783-48bd-8819-85126a8e66a8",
+ "processingCount": 188
</file context>
| "processingTime": 28611.279511, | |
| "processingTime": "2025-10-27T12:05:43Z", |
✅ Addressed in abef802
|
|
||
| ```json | ||
| { | ||
| "output": { |
There was a problem hiding this comment.
Example 3 should not wrap the response in an output object because the documented outputs are top-level fields. Please remove that wrapper so the payload shape matches the rest of the documentation.
Prompt for AI agents
Address the following comment on Workflow/AI-Nodes/Text-Extraction.mdx at line 224:
<comment>Example 3 should not wrap the response in an `output` object because the documented outputs are top-level fields. Please remove that wrapper so the payload shape matches the rest of the documentation.</comment>
<file context>
@@ -0,0 +1,320 @@
+
+```json
+{
+ "output": {
+ "content": "The evening sky was painted with shades of orange and violet. As the city slowly settled into its nightly rhythm. Streetlights flickered to life, casting warm pools of light on the sidewalks where people hurried home, their faces half hidden behind scarves and tired smiles. Somewhere, a musician played a soft tune on a saxophone, its notes drifting between buildings like fragments of a forgotten dream. In the distance, the sound of traffic blended with laughter spilling out of a nearby cafe. Inside, a, uh, writer sat alone with a cup of coffee gone cold, his laptop open but untouched. He watched the rain begin to fall against the window, tracing patterns that matched the rhythm of his thoughts. Every drop felt like a reminder that even in a crowded city, moments of stillness could be found in the smallest details. A quiet song, a stranger's laughter, or the glow of street lights reflecting on wet pavement. And in that quiet, he finally began to type M. Not to impress anyone or chase perfection, but simply to capture the fleeting beauty of the world as he saw it.",
+ "processingTime": 28611.279511,
</file context>
|
|
||
| --- | ||
|
|
||
| Here’s your **Common Errors** section rewritten in bullet-point format to match your documentation style and maintain clarity for beginners: |
There was a problem hiding this comment.
Remove the meta-instructional sentence so the Common Errors section reads like end-user documentation rather than editing notes.
Prompt for AI agents
Address the following comment on Workflow/AI-Nodes/Text-to-speech.mdx at line 173:
<comment>Remove the meta-instructional sentence so the Common Errors section reads like end-user documentation rather than editing notes.</comment>
<file context>
@@ -0,0 +1,198 @@
+
+---
+
+Here’s your **Common Errors** section rewritten in bullet-point format to match your documentation style and maintain clarity for beginners:
+
+---
</file context>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
Workflow/AI-Nodes/Image-generation.mdx (1)
23-25: ** Remove leftover template instruction text.**Lines 23–25 contain template/authoring instruction text that was flagged in a previous review:
Here's your **Input Parameters** section rewritten in bullet-point format for the **Image Generation** node — consistent with your documentation style and beginner-friendly:This must be deleted so only the intended documentation content remains. The section divider should follow immediately after line 22.
Apply this diff:
- - Here's your **Input Parameters** section rewritten in bullet-point format for the **Image Generation** node — consistent with your documentation style and beginner-friendly: - - ---Workflow/AI-Nodes/Content-Moderation.mdx (1)
22-24: ** Remove template instruction text.**Lines 22–24 contain leftover template/meta text from document generation that should not appear in published documentation:
Here's your **Input Parameters** section rewritten in clear bullet-point format — consistent with your official documentation style and easy for beginners to follow: ---Delete these lines entirely. The Input Parameters heading should follow directly on line 26.
Apply this diff:
--- -Here's your **Input Parameters** section rewritten in clear bullet-point format — consistent with your official documentation style and easy for beginners to follow: - ---- ## Input ParametersWorkflow/AI-Nodes/Text-Extraction.mdx (1)
220-231: ** Remove unnecessary "output" wrapper from Example 3.**Example 3's Expected Output (lines 224–231) wraps the response in an extra
"output": { }object, which is inconsistent with Examples 1 and 2 and breaks the documented structure.The output should be top-level fields, not nested inside an
"output"key.Apply this diff:
**Expected Output:** ```json - { - "output": { "content": "The evening sky was painted...", "processingTime": "2025-10-27T12:05:43Z", "processingId": "dc9509af-3783-48bd-8819-85126a8e66a8", "processingCount": 188 - } - }</blockquote></details> </blockquote></details> <details> <summary>🧹 Nitpick comments (8)</summary><blockquote> <details> <summary>Workflow/Database/query-data.mdx (2)</summary><blockquote> `57-62`: **Vary phrasing to improve readability.** Line 58 uses "you want to retrieve" but this phrasing appears earlier in the document. Consider rephrasing to reduce repetition: ```diff -* **Limit:** - Specify how many records you want to retrieve at most. +* **Limit:** + Specify the maximum number of records to retrieve.
230-232: Strengthen the phrasing on missed requirements.Line 231 uses the phrasal verb "left out," which is informal for technical documentation. Use a stronger verb instead:
- You might have left out a necessary input or not connected upstream nodes correctly. + You might have omitted a necessary input or failed to connect upstream nodes correctly.Workflow/Utility/Handle-Variable.mdx (1)
76-76: Minor: Consider stronger word choice.The static analysis tool suggests using "brief" instead of "short" on line 76 to strengthen your wording. This is a low-priority style improvement.
Workflow/Utility/Google-Maps.mdx (1)
128-131: Fix grammar: Replace "requires input" with clearer phrasing.Line 130 uses "requires input" which is flagged as nonstandard English. Replace with "requires," "needs," or "requires input to be provided" for clarity.
Workflow/Triggers/Time-Based-Runs.mdx (1)
116-118: Optional: Vary sentence structure to reduce repetition.Lines 116–118 begin three consecutive bullet points with "Use". Consider rewording one or two bullets for better readability (e.g., "For simple repeat tasks, use interval...").
Workflow/Process-Nodes/return-state.mdx (1)
24-27: Optional: Strengthen wording with "brief" instead of "short".Line 26 uses "short description" which can be strengthened. Consider using "brief description" for more concise phrasing, as suggested by style analysis.
Workflow/AI-Nodes/Text-Extraction.mdx (1)
15-15: Optional: Simplify phrasing for clarity.Line 15 uses "automatically pull text and metadata from a variety of input formats" which can be simplified. Consider: "automatically extract text and metadata from various input formats" (removes the split infinitive and uses more concise language).
docs.json (1)
120-186: Normalize JSON formatting to match established convention.The newly added Workflow tab uses spaces around colons (e.g.,
"group" : "Triggers") while the existing Documentation and API Reference tabs follow a consistent no-space convention (e.g.,"group": "System"). Standardize the Workflow tab to match the established style.Apply this diff to normalize formatting:
- { - "tab" : "Workflow", - "groups" : [ + { + "tab": "Workflow", + "groups": [ { - "group" : "Triggers", - "pages" : [ + "group": "Triggers", + "pages": [ "workflow/triggers/rest-api-trigger", "workflow/triggers/file-upload-trigger", "workflow/triggers/time-based-runs", "workflow/triggers/email-trigger", - "workflow/triggers/whatsapp-trigger" + "workflow/triggers/whatsapp-trigger" ] }, { - "group" : "AI-Nodes", - "pages" : [ + "group": "AI-Nodes", + "pages": [ "workflow/ai-nodes/text-generation", "workflow/ai-nodes/text-to-speech", "workflow/ai-nodes/image-generation", "workflow/ai-nodes/image-analysis", "workflow/ai-nodes/content-moderation", "workflow/ai-nodes/text-extraction" - + ] }, { - "group" : "Utility", - "pages" : [ + "group": "Utility", + "pages": [ "workflow/utility/send-mail", "workflow/utility/html-pdf", "workflow/utility/calendar-add-event", @@ -156,20 +156,20 @@ "workflow/utility/handle-variable", "workflow/utility/send-whatsapp", - "workflow/utility/send-sms-using-plivo", - "workflow/utility/http-request" - - + "workflow/utility/send-sms-using-plivo", + "workflow/utility/http-request" ] }, { "group": "Database", "pages": [ "workflow/database/add-new-data", "workflow/database/update-data", "workflow/database/delete-data", "workflow/database/fetch-data", "workflow/database/query-data", "workflow/database/create-graphs" ] }, { - "group" : "Process Nodes", - "pages" : [ + "group": "Process Nodes", + "pages": [ "workflow/process-nodes/if-else-condition", "workflow/process-nodes/loop-process", "workflow/process-nodes/for-loop", "workflow/process-nodes/switch-case", - "workflow/process-nodes/return-state" - + "workflow/process-nodes/return-state" ] } ]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
Workflow/AI-Nodes/Content-Moderation.mdx(1 hunks)Workflow/AI-Nodes/Image-analysis.mdx(1 hunks)Workflow/AI-Nodes/Image-generation.mdx(1 hunks)Workflow/AI-Nodes/Text-Extraction.mdx(1 hunks)Workflow/Database/query-data.mdx(1 hunks)Workflow/Process-Nodes/return-state.mdx(1 hunks)Workflow/Triggers/Email-Trigger.mdx(1 hunks)Workflow/Triggers/Time-Based-Runs.mdx(1 hunks)Workflow/Utility/Calendar-Add-Event.mdx(1 hunks)Workflow/Utility/Calendar-Fetch-Events.mdx(1 hunks)Workflow/Utility/Google-Maps.mdx(1 hunks)Workflow/Utility/Handle-Variable.mdx(1 hunks)Workflow/Utility/Http-Request.mdx(1 hunks)Workflow/Utility/Send-Sms-Using-Plivo.mdx(1 hunks)Workflow/Utility/Web-Search.mdx(1 hunks)Workflow/Utility/send-mail.mdx(1 hunks)docs.json(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (5)
- Workflow/Utility/Http-Request.mdx
- Workflow/Triggers/Email-Trigger.mdx
- Workflow/Utility/Send-Sms-Using-Plivo.mdx
- Workflow/Utility/send-mail.mdx
- Workflow/AI-Nodes/Image-analysis.mdx
🧰 Additional context used
🪛 LanguageTool
Workflow/AI-Nodes/Text-Extraction.mdx
[style] ~15-~15: Try moving the adverb to make the sentence clearer.
Context: ...low. --- ## Description This node is designed to automatically pull text and metadata from a variety of input formats — inclu...
(SPLIT_INFINITIVE)
[style] ~15-~15: Consider using a more concise synonym.
Context: ...tomatically pull text and metadata from a variety of input formats — including **documents, ...
(A_VARIETY_OF)
Workflow/Database/query-data.mdx
[style] ~58-~58: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...Limit:** Specify how many records you want to retrieve at most. * **Start After / Of...
(REP_WANT_TO_VB)
[style] ~231-~231: To strengthen your wording, consider replacing the phrasal verb “leave out”.
Context: ...sing required field:** You might have left out a necessary input or not connected upst...
(OMIT_EXCLUDE)
Workflow/Process-Nodes/return-state.mdx
[style] ~26-~26: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ...0 for success). * message – gives a short description of the result. * data –...
(QUICK_BRIEF)
Workflow/Triggers/Time-Based-Runs.mdx
[style] ~118-~118: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...edules (e.g., “every day at 9am”). * Use cron_description for advanced timin...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Workflow/Utility/Google-Maps.mdx
[style] ~130-~130: The double modal “requires input” is nonstandard (only accepted in certain dialects). Consider “to be input”.
Context: ...* * If the selected option requires input (such as addresses or coordinates), use...
(NEEDS_FIXED)
Workflow/Utility/Handle-Variable.mdx
[style] ~76-~76: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ...u want to store. 5. Optionally, write a short description. 6. Save changes and connec...
(QUICK_BRIEF)
🔇 Additional comments (5)
Workflow/Database/query-data.mdx (2)
138-138: Past issue resolved: Output message is now consistent with sample data.The previous review flagged an inconsistency between the success message and data count. The current examples correctly show "Successfully fetched 2 documents" matching the 2 records in the data array.
Also applies to: 170-170
1-240: Comprehensive and well-structured documentation.The documentation provides clear explanations of the Query Data Node with well-organized sections covering parameters, outputs, practical examples, integration patterns, and troubleshooting. The examples are realistic and the best practices section offers valuable guidance for users. The structure and content align well with the PR objectives.
Workflow/Utility/Calendar-Add-Event.mdx (1)
1-271: LGTM!This file is well-structured and comprehensive. The past review comment about ISO duration format (line 158) has been correctly applied —
processingTimenow uses the proper"PT2S"format. The examples are clear, the usage steps are practical, and the error handling guidance is helpful.Workflow/Utility/Calendar-Fetch-Events.mdx (1)
155-175: Data consistency verified in examples.The
totalEventscount now correctly matches the number of events in both examples (Example 1: 2 events, totalEvents: 2; Example 2: 2 events, totalEvents: 2). This resolves the prior review feedback.Workflow/Utility/Web-Search.mdx (1)
1-191: Well-structured node documentation.The Web Search node documentation is comprehensive and clearly organized. Input and output parameters are well-defined, realistic examples demonstrate typical use cases, and the no-code workflow guidance and error handling sections provide practical value. Consistent with the documentation standards established across other node docs.
| * **flaggedCategories** | ||
| A comma-separated list of the categories that were flagged during moderation. | ||
| Example: `"violence,hate,harassment"` | ||
|
|
There was a problem hiding this comment.
Fix type mismatch: flaggedCategories documented as string but shown as array in Example 1.
Output Parameters (lines 88–90) document flaggedCategories as "A comma-separated list of the categories that were flagged during moderation. Example: "violence,hate,harassment""
However, Example 1 Expected Output (lines 161–163) shows flaggedCategories as a JSON array:
"flaggedCategories": [
"harassment"
]These must align. Either:
- Change the output documentation to reflect an array type, or
- Update Example 1 to show a comma-separated string
Please align the example with the documented output type.
Also applies to: 157-183
🤖 Prompt for AI Agents
In Workflow/AI-Nodes/Content-Moderation.mdx around lines 88–91 (and also update
occurrences in lines 157–183), the docs describe flaggedCategories as a
comma-separated string but Example 1 shows a JSON array; make them consistent by
changing the output documentation to describe flaggedCategories as an array of
strings (e.g., "An array of the categories that were flagged during moderation")
and update the inline example text to show the array type, ensuring the Example
1 expected output remains a JSON array (and any other examples in 157–183
reflect the same array type).
1 participant
Updated the remaining utility nodes.
Summary by cubic
Added a new Workflow docs tab with grouped navigation and comprehensive node docs across Triggers, AI, Database, Process, and Utility. Updated node descriptions for clarity and consistency to improve onboarding and discoverability.
New Features
Bug Fixes
Summary by CodeRabbit