[No Code Agents] Docs updates #153
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
📝 WalkthroughSummary by CodeRabbit
WalkthroughNavigation and docs under "Agent via No-Code Builder" were reworked to focus on prompt chains: pages replaced, several MDX files added/removed, images and UI instructions updated, and one MDX component tag fixed. No runtime or API code changes. Changes
Sequence Diagram(s)Not applicable — changes are documentation, navigation, and asset updates only. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Areas to check:
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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: 6
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
offline-evals/via-ui/agents-via-no-code-builder/debug-errors-at-every-node.mdx (1)
99-107: Use hyphen in compound adjective "right-click".Line 103 has a grammar issue: use a hyphen to join words. Change "Right click/click on three dots" to "Right-click/click on the three dots".
docs.json (1)
958-963: Fix inconsistent redirect destination paths.Lines 959 and 963 have redirect destinations without leading slashes, which is inconsistent with the standard redirect format used throughout the rest of the file:
{ "source": "/evaluate/how-to/evaluate-chains/querying-prompt-chains", - "destination": "offline-evals/via-sdk/agent-no-code/quickstart" + "destination": "/offline-evals/via-sdk/agent-no-code/quickstart" }, { "source": "/evaluate/how-to/evaluate-chains/test-prompt-chains", - "destination": "offline-evals/via-sdk/agent-http/quickstart" + "destination": "/offline-evals/via-sdk/agent-http/quickstart" },All other redirect rules (e.g., lines 887, 898, 927) use the leading slash format. Add leading slashes for consistency and to ensure correct routing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (35)
images/docs/evaluate/how-to/prompt-chains/add-api-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/add-prompt-state.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/agents-multilingual-variables.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/agents-variables-dataset.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/agents-variables-test-run-report.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/api-node-editor.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/api-node-variables.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/api-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/code-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/conditional-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/edit-api-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/new-node-state.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/output-field-selector.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/product-description-generator-and-translator-chain.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/product-images-dataset.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-error-state.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-infinite-loop-trace-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-infinite-loop.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-input.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-loops-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-loops.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-merge-strategies.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-sheet-filtering.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-test-run-dataset.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-test-run-report.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-test-run-trigger-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-trace-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-tool-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/test-chain.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/translator.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/create-ticket-in-helpdesk-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/multi-agent-system-code.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/multi-agent-system-routing-agent.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/multi-agent-system.pngis excluded by!**/*.png
📒 Files selected for processing (14)
docs.json(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/agent-evals.mdx(0 hunks)offline-evals/via-ui/agents-via-no-code-builder/debug-errors-at-every-node.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/deploy-prompt-chains.mdx(4 hunks)offline-evals/via-ui/agents-via-no-code-builder/experiment-with-prompt-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/meta.json(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/multi-agent-system.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/quickstart.mdx(0 hunks)offline-evals/via-ui/agents-via-no-code-builder/test-prompt-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/use-api-nodes-within-chains.mdx(2 hunks)offline-evals/via-ui/agents-via-no-code-builder/use-loops-in-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/use-variables-in-agents.mdx(1 hunks)sdk/python/integrations/langgraph/langgraph-with-decorator.mdx(1 hunks)
💤 Files with no reviewable changes (2)
- offline-evals/via-ui/agents-via-no-code-builder/quickstart.mdx
- offline-evals/via-ui/agents-via-no-code-builder/agent-evals.mdx
🧰 Additional context used
🪛 LanguageTool
offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx
[grammar] ~103-~103: Use a hyphen to join words.
Context: ...im dashboard to get folder id. 1. Right click/click on three dots on the folder ...
(QB_NEW_EN_HYPHEN)
[style] ~395-~395: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...pt chain version marked as fallback. 5. If we still don't find any prompt chain, w...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (4)
offline-evals/via-ui/agents-via-no-code-builder/debug-errors-at-every-node.mdx (2)
1-34: Content restructuring looks good.The documentation has been well-updated to cover error debugging, loops debugging, and search/filtering with clear examples and revised UI instructions. The narrative flows logically and provides practical guidance.
14-14: All image paths verified—no action required.All 5 image files referenced in the file (
prompt-chain-error-state.png,prompt-chain-trace-sheet.png,prompt-chain-infinite-loop.png,prompt-chain-infinite-loop-trace-sheet.png,prompt-chain-sheet-filtering.png) exist at the specified/images/docs/evaluate/how-to/prompt-chains/paths.offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx (1)
1-6: Document structure and content are comprehensive.The file provides clear organization with SDK initialization, deployment variables, querying, data structures, caching, and matching algorithm explanations. Code examples for both TypeScript and Python are well-formatted with appropriate use of CodeGroup components. Once the syntax and method name errors are corrected, this documentation will be solid.
Once you fix the critical issues flagged above, please verify:
- The corrected TypeScript import statements compile/syntax-check correctly
- The Python method names
get_prompt_chains()andget_folders()are accurate per the current SDK APIdocs.json (1)
52-60: Navigation structure updated correctly.The "Agent via No-Code Builder" pages array has been successfully updated with all nine new pages in full path format, matching the meta.json structure and maintaining the new focus on prompt chains. Navigation hierarchy looks well-organized.
offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx
Outdated
Show resolved
Hide resolved
offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx
Show resolved
Hide resolved
offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx
Show resolved
Hide resolved
offline-evals/via-ui/agents-via-no-code-builder/use-variables-in-agents.mdx
Outdated
Show resolved
Hide resolved
SamstyleGhost
force-pushed
the
10-27-_no_code_agents_docs_updates
branch
from
174c6f3 to
7ade5df
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
offline-evals/via-ui/agents-via-no-code-builder/deploy-prompt-chains.mdx (1)
50-50: Fix TypeScript import statement syntax error.Line 50 is missing a closing quote before the semicolon.
- import { Maxim, QueryBuilder } from "@maximai/maxim-js; + import { Maxim, QueryBuilder } from "@maximai/maxim-js";
♻️ Duplicate comments (6)
sdk/python/integrations/langgraph/langgraph-with-decorator.mdx (1)
212-217: Fix self-closing Card component syntax error (reoccurrence).The
Cardcomponent must use a proper closing tag, not self-closing syntax. Self-closing tags (/>) are only for void elements; JSX components require closing tags. This issue was flagged in a previous review and remains unfixed.Apply this diff to fix the syntax error:
<CardGroup cols={2}> <Card title="LangGraph integration with decorator (GitHub)" icon="github" href="https://github.com/maximhq/maxim-cookbooks/blob/main/python/observability-online-eval/langgraph/tavily-search-with-decorators.ipynb" - /> + </Card> </CardGroup>offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx (5)
188-188: Fix TypeScript import statement syntax error.The import statement is missing a closing quote before the semicolon. This will cause a syntax error when the code block is executed or referenced.
- import { Maxim, QueryBuilder } from "@maximai/maxim-js; + import { Maxim, QueryBuilder } from "@maximai/maxim-js";
175-181: Fix Python method name in "Retrieving Deployed Prompts from a Folder" section.Line 175 calls
maxim.get_folders(), but this should bemaxim.get_prompt_chains()to match the TypeScript version and retrieve deployed prompt chains (not folders).folder = maxim.get_folder_by_id("folder-id") - promptChains = maxim.get_folders( + prompt_chains = maxim.get_prompt_chains( QueryBuilder() .and_() .folder(folder.id) .deployment_var("Environment", "prod") .build())
208-213: Fix Python method name in "Filtering Prompt Chains by Deployment Variables" section.Line 208 calls
maxim.get_prompt_chain()(singular), but should callmaxim.get_prompt_chains()(plural) to match the TypeScript version and correctly retrieve multiple chains matching the filter criteria.folder = maxim.get_folder_by_id("folder-id") - prompt_chains = maxim.get_prompt_chain( + prompt_chains = maxim.get_prompt_chains( QueryBuilder() .and_() .folder(folder.id) .deployment_var("Environment", "prod") .build())
402-402: Fix TypeScript import statement syntax error.The import statement is missing a closing quote before the semicolon. This will cause a syntax error when the code block is executed or referenced.
- import { QueryBuilder } from "@maximai/maxim-js; + import { QueryBuilder } from "@maximai/maxim-js";
431-431: Fix TypeScript import statement syntax error.The import statement is missing a closing quote before the semicolon. This will cause a syntax error when the code block is executed or referenced.
- import { Maxim, QueryBuilder } from "@maximai/maxim-js; + import { Maxim, QueryBuilder } from "@maximai/maxim-js";
🧹 Nitpick comments (2)
offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx (2)
103-105: Minor grammar improvement: use hyphen for compound modifier.Line 103 contains "Right click/click" which should be hyphenated as "Right-click/click" to follow standard punctuation conventions for compound modifiers.
- 1. Right click/click on three dots on the folder you want to get id for. + 1. Right-click/click on three dots on the folder you want to get id for.
389-395: Minor style improvement: vary sentence starters in matching algorithm section.Lines 393–395 contain three consecutive sentences beginning with "If", which reduces readability. Consider rewording for variety.
Current text:
- "If we don't find any matching entity, we enforce only
deploymentVarconditions..."- "If we still don't find any prompt chain, we check for a prompt chain version..."
- "If we still don't find any prompt chain, we return
null."Suggested revision:
3. **If we don't find any matching entity, we enforce only `deploymentVar` conditions (you can override this behaviour, as explained in the next section) and match as many tags as possible.** - 4. If we still don't find any prompt chain, we check for a prompt chain version marked as fallback. - 5. If we still don't find any prompt chain, we return `null`. + 4. When no matches are found, we check for a prompt chain version marked as fallback. + 5. Finally, if no prompt chain is located, we return `null`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (45)
images/docs/evaluate/how-to/prompt-chains/add-api-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/add-prompt-state.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/agents-multilingual-variables.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/agents-variables-dataset.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/agents-variables-test-run-report.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/api-node-editor.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/api-node-variables.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/api-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/code-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/conditional-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/edit-api-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/new-node-state.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/output-field-selector.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/product-description-generator-and-translator-chain.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/product-images-dataset.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-error-state.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-infinite-loop-trace-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-infinite-loop.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-input.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-loops-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-loops.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-merge-strategies.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-sheet-filtering.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-test-run-dataset.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-test-run-report.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-test-run-trigger-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-chain-trace-sheet.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/prompt-tool-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/test-chain.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/translator.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/api-block-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/code-block-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/create-ticket-in-helpdesk-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/customer-support-agent.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/email-classifier-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/multi-agent-system-code.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/multi-agent-system-routing-agent.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/multi-agent-system.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/priority-scorer-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/product-description-generator-and-translator-chain.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/product-description-generator-bot-prompt-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/send-email-response-api-block.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/support-response-generator-node.pngis excluded by!**/*.pngimages/docs/evaluate/how-to/prompt-chains/tutorials/translator-prompt-node.pngis excluded by!**/*.png
📒 Files selected for processing (14)
docs.json(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/agent-evals.mdx(0 hunks)offline-evals/via-ui/agents-via-no-code-builder/debug-errors-at-every-node.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/deploy-prompt-chains.mdx(4 hunks)offline-evals/via-ui/agents-via-no-code-builder/experiment-with-prompt-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/meta.json(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/multi-agent-system.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/quickstart.mdx(0 hunks)offline-evals/via-ui/agents-via-no-code-builder/test-prompt-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/use-api-nodes-within-chains.mdx(2 hunks)offline-evals/via-ui/agents-via-no-code-builder/use-loops-in-chains.mdx(1 hunks)offline-evals/via-ui/agents-via-no-code-builder/use-variables-in-agents.mdx(1 hunks)sdk/python/integrations/langgraph/langgraph-with-decorator.mdx(1 hunks)
💤 Files with no reviewable changes (2)
- offline-evals/via-ui/agents-via-no-code-builder/agent-evals.mdx
- offline-evals/via-ui/agents-via-no-code-builder/quickstart.mdx
✅ Files skipped from review due to trivial changes (1)
- offline-evals/via-ui/agents-via-no-code-builder/use-variables-in-agents.mdx
🚧 Files skipped from review as they are similar to previous changes (6)
- offline-evals/via-ui/agents-via-no-code-builder/test-prompt-chains.mdx
- offline-evals/via-ui/agents-via-no-code-builder/multi-agent-system.mdx
- offline-evals/via-ui/agents-via-no-code-builder/use-loops-in-chains.mdx
- offline-evals/via-ui/agents-via-no-code-builder/debug-errors-at-every-node.mdx
- offline-evals/via-ui/agents-via-no-code-builder/experiment-with-prompt-chains.mdx
- docs.json
🧰 Additional context used
🪛 LanguageTool
offline-evals/via-ui/agents-via-no-code-builder/querying-prompt-chains.mdx
[grammar] ~103-~103: Use a hyphen to join words.
Context: ...im dashboard to get folder id. 1. Right click/click on three dots on the folder ...
(QB_NEW_EN_HYPHEN)
[style] ~395-~395: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...pt chain version marked as fallback. 5. If we still don't find any prompt chain, w...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (2)
offline-evals/via-ui/agents-via-no-code-builder/use-api-nodes-within-chains.mdx (1)
1-50: Clear and well-structured update.The content restructuring for Prompt Chains is logical, and the new "Using variables" section provides useful guidance. The step-by-step instructions are easy to follow, and image references follow consistent naming conventions.
offline-evals/via-ui/agents-via-no-code-builder/meta.json (1)
1-13: Configuration aligned with documentation restructuring.The meta.json updates properly reflect the shift from agent-focused documentation to prompt-chain-focused content. The title change to "Evaluate Chains" and the updated pages array are consistent with the other file changes in this PR.
Please verify that all eight pages referenced in the
pagesarray have corresponding.mdxfiles in theoffline-evals/via-ui/agents-via-no-code-builder/directory to ensure the navigation structure is complete.
Merge activity
|
Uh oh!
There was an error while loading. Please reload this page.