Skip to content

Conversation

@impoiler
Copy link
Contributor

No description provided.

Copy link
Contributor Author

impoiler commented Oct 27, 2025

@impoiler impoiler mentioned this pull request Oct 27, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 27, 2025

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for mapping variables to evaluators from prompts, workflows, and datasets
    • Covers variable mapping for single-turn and multi-turn workflows, voice agents, and no-code agents
    • Includes details on automatic population and fallback behavior for evaluator inputs

Walkthrough

Adds a new evaluator documentation page and updates documentation metadata: creates library/evaluators/variables-mapping.mdx, registers the page in library/evaluators/meta.json, and adds the doc entry to docs.json. No code or API changes.

Changes

Cohort / File(s) Summary
New documentation page
library/evaluators/variables-mapping.mdx
New MDX documenting how to map dataset, run, prompt, workflow, voice-agent, and no-code-agent variables to evaluator inputs; describes prefixes (e.g., dataset., run., version.), single-turn vs multi-turn context rules, workflow/voice session examples, and automatic mapping population with dataset-column fallbacks.
Docs metadata updates
docs.json, library/evaluators/meta.json
Added page entry library/evaluators/variables-mapping to docs.json and inserted "variables-mapping" into library/evaluators/meta.json pages array (positioned after sessions-in-evaluators and before folders-in-evaluators). No behavioral changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Pay attention to:
    • Accuracy and clarity of examples and prefix names in library/evaluators/variables-mapping.mdx.
    • Correct ordering and paths in docs.json and library/evaluators/meta.json.
    • Internal links and routing for the new docs page.

Poem

🐇 I hopped through lines to map each name,
Dataset seeds and runs in gentle frame,
Prompts and workflows, sessions align,
I stitched the keys so docs could shine,
A tiny rabbit's guide — concise and tame.

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author. While the title and objectives provide some context, a description is an important communication tool for reviewers to understand the motivation, scope, and any special considerations for the changes. Add a pull request description explaining the purpose of the new documentation, what the 'Map Variables to Evaluators' feature does, and any context reviewers should be aware of when reviewing the documentation changes.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title '[Maxim] Varibles mapping docs' is related to the changeset, which adds documentation for a 'Map Variables to Evaluators' feature. However, the title contains a typo ('Varibles' instead of 'Variables'), is prefixed with '[Maxim]' which appears to be a non-standard convention, and is somewhat vague about the specific purpose of the documentation.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch improvement/variables-mapping-docs

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 86ba9bc and 4b2b78e.

📒 Files selected for processing (3)
  • docs.json (1 hunks)
  • library/evaluators/meta.json (1 hunks)
  • library/evaluators/variables-mapping.mdx (1 hunks)
🔇 Additional comments (3)
library/evaluators/meta.json (1)

8-8: ✓ Consistent ordering achieved.

The new variables-mapping page entry is correctly positioned and now aligns with docs.json ordering, resolving the prior navigation inconsistency. The changes are structurally sound.

docs.json (1)

295-297: ✓ Navigation ordering synchronized with meta.json.

The evaluator pages are now ordered consistently across both configuration files, ensuring unified navigation structure across the documentation site.

library/evaluators/variables-mapping.mdx (1)

1-214: ✓ Documentation page properly structured and hyphenation corrected.

The new variables-mapping.mdx page provides clear, comprehensive documentation with well-organized sections covering all entity types (dataset, prompt, workflow, voice agent, no-code agent). The hyphenation of "no-code agent" on lines 207 and 209 is now correct. Examples are detailed and useful for understanding session structures in multi-turn scenarios.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
library/evaluators/variables-mapping.mdx (1)

1-214: Documentation coverage looks comprehensive.

The file provides clear, well-organized documentation of variable mapping across all entity types (prompts, workflows, voice agents, no-code agents). Variable types are consistently annotated with data types (String, JSON, etc.), and the JSON examples for multi-turn session structures are realistic and helpful. The fallback behavior and automatic population logic are explained upfront.

One suggestion: consider linking related sections or cross-referencing common structures (e.g., the run.session structure is identical for both workflows and voice agents) to help readers navigate between related entity types.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 850a4ff and fa8071c.

📒 Files selected for processing (1)
  • library/evaluators/variables-mapping.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
library/evaluators/variables-mapping.mdx

[grammar] ~209-~209: Use a hyphen to join words.
Context: ...o code agent Variable Mapping Access no code agent run data: - run.input (`St...

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (1)
library/evaluators/variables-mapping.mdx (1)

6-7: Verify unused imports.

The MaximPlayer and Plus imports are declared but do not appear to be used in this documentation file. If they are not needed, remove them to keep the file clean.

@impoiler impoiler force-pushed the improvement/variables-mapping-docs branch 3 times, most recently from a538622 to 86ba9bc Compare November 3, 2025 14:51
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0ba6acc and 86ba9bc.

📒 Files selected for processing (3)
  • docs.json (1 hunks)
  • library/evaluators/meta.json (1 hunks)
  • library/evaluators/variables-mapping.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • library/evaluators/variables-mapping.mdx

coderabbitai[bot]
coderabbitai bot previously approved these changes Nov 3, 2025
Copy link
Contributor Author

impoiler commented Nov 3, 2025

Merge activity

  • Nov 3, 4:51 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Nov 5, 4:20 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Nov 5, 4:45 AM UTC: Graphite couldn't merge this PR because it failed for an unknown reason (GitHub is reporting that this PR is not mergeable, despite passing required status checks defined by your branch protection rules. Please check your rulesets for additional blocking criteria. Graphite Merge Queue does not currently support rulesets. Please contact Graphite support for further assistance.).
  • Nov 5, 2:50 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Nov 5, 2:51 PM UTC: @akshaydeo merged this pull request with Graphite.

@akshaydeo akshaydeo merged commit 1d1b7f9 into main Nov 5, 2025
2 checks passed
@akshaydeo akshaydeo deleted the improvement/variables-mapping-docs branch November 5, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants