Skip to content

fix(docs): Studio data designer schema docs - #1169

Merged
steramae-nvidia merged 1 commit into
mainfrom
steramae/schema-dd-docs
Aug 7, 2026
Merged

fix(docs): Studio data designer schema docs#1169
steramae-nvidia merged 1 commit into
mainfrom
steramae/schema-dd-docs

Conversation

@steramae-nvidia

@steramae-nvidia steramae-nvidia commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

https://nvbugspro.nvidia.com/bug/6567681

Signed-off-by: Sean Teramae steramae@nvidia.com

Summary

Related Issue

Changes

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification:
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification:

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted validation:

Summary by CodeRabbit

  • Documentation
    • Updated the Data Designer guide with details about list and canvas views, view toggling, and dependency indicators.
    • Clarified how columns are added and removed.
    • Updated preview validation and details-panel terminology for consistency.

Signed-off-by: Sean Teramae <steramae@nvidia.com>
@steramae-nvidia
steramae-nvidia requested review from a team as code owners August 7, 2026 16:15
@steramae-nvidia

Copy link
Copy Markdown
Contributor Author

This change is part of the following stack:

Change managed by git-spice.

@github-actions github-actions Bot added the fix label Aug 7, 2026
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The Data Designer guide now describes the builder’s list and canvas views, view switching, dependency indicators, column operations, and updated validation wording.

Changes

Data Designer builder guide

Layer / File(s) Summary
Builder terminology and workflow
docs/studio/data-designer-build.mdx
The guide consistently uses “builder” terminology and updates the empty-recipe validation text to “no columns added.”
Builder views and column interactions
docs/studio/data-designer-build.mdx
The guide documents list and canvas views, the view toggle, dependency tags and arrows, and adding or removing columns from either view.

Possibly related PRs

Suggested reviewers: marcusds, nakolean

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies a documentation fix for the Studio data designer schema, which matches the main change.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch steramae/schema-dd-docs

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/studio/data-designer-build.mdx`:
- Line 113: Update the removal instruction near the column deletion guidance to
use view-neutral terminology: tell users to select the column in either view and
then choose Remove in the config pane, while preserving the existing trash-icon
instruction for list view.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 47eeb115-67e0-4096-a938-ac409bf8ef0c

📥 Commits

Reviewing files that changed from the base of the PR and between 8dc62ed and 33136df.

📒 Files selected for processing (1)
  • docs/studio/data-designer-build.mdx

Comment thread docs/studio/data-designer-build.mdx
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 31467/40086 78.5% 63.1%
Integration Tests 18326/38038 48.2% 20.8%

@steramae-nvidia
steramae-nvidia added this pull request to the merge queue Aug 7, 2026
Merged via the queue into main with commit 14ad8cf Aug 7, 2026
57 checks passed
@steramae-nvidia
steramae-nvidia deleted the steramae/schema-dd-docs branch August 7, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants