Skip to content

fix(studio): Docs for Data Designer - #790

Merged
steramae-nvidia merged 6 commits into
mainfrom
steramae/dd-docs
Jul 20, 2026
Merged

fix(studio): Docs for Data Designer#790
steramae-nvidia merged 6 commits into
mainfrom
steramae/dd-docs

Conversation

@steramae-nvidia

@steramae-nvidia steramae-nvidia commented Jul 20, 2026

Copy link
Copy Markdown
Contributor
localhost_3000_nemo-platform_documentation_studio_data-designer

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

Summary by CodeRabbit

  • Documentation
    • Added a new Data Designer guide for NeMo Studio.
    • Documented the end-to-end workflow, from creating/selecting jobs and building recipes to previewing generated rows, submitting jobs, and reviewing job results.
    • Included guidance on validation, job details (profile/data/output), and how edits persist by file format.
    • Added the guide to the Studio documentation navigation.

@steramae-nvidia
steramae-nvidia requested review from a team as code owners July 20, 2026 17:52
@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 Jul 20, 2026
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: cccc92d2-f234-4c23-a05a-14fee7ca06e8

📥 Commits

Reviewing files that changed from the base of the PR and between 9b67d93 and 96d5a6f.

📒 Files selected for processing (1)
  • docs/studio/data-designer-build.mdx
💤 Files with no reviewable changes (1)
  • docs/studio/data-designer-build.mdx

📝 Walkthrough

Walkthrough

Added Data Designer documentation and Studio navigation, plus generated-file checks that isolate newly introduced changes from pre-existing diffs.

Changes

Data Designer documentation

Layer / File(s) Summary
Navigation and job entry flow
docs/fern/versions/latest.yml, docs/studio/data-designer-build.mdx
Adds the Data Designer navigation entry and documents job listing, filtering, and creation entry points.
Builder configuration and job creation
docs/studio/data-designer-build.mdx
Documents the DAG builder, columns, models, validation, preview, and job creation behavior.
Job details and output editing
docs/studio/data-designer-build.mdx
Describes completed job details, output files, row editing, persistence rules, limitations, and related topics.

Generated-file synchronization checks

Layer / File(s) Summary
Newly generated file detection
web/packages/scripts/src/check-generated-files.ts
Captures the initial changed-file set, reports only newly changed files after generation, and preserves mismatch failure behavior.

Suggested labels: docs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the main change: adding Studio documentation for Data Designer.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch steramae/dd-docs

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

@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 26385/34036 77.5% 61.7%
Integration Tests 15175/32661 46.5% 18.7%

@steramae-nvidia
steramae-nvidia added this pull request to the merge queue Jul 20, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 20, 2026
@steramae-nvidia
steramae-nvidia added this pull request to the merge queue Jul 20, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 20, 2026
Signed-off-by: Sean Teramae <steramae@nvidia.com>
Signed-off-by: Sean Teramae <steramae@nvidia.com>
Signed-off-by: Sean Teramae <steramae@nvidia.com>
Signed-off-by: Sean Teramae <steramae@nvidia.com>

@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 `@web/packages/scripts/src/check-generated-files.ts`:
- Around line 11-12: Update the before/after snapshots in the generated-file
check around execAsync and beforeFiles to use path-only output from the same
repository reference, such as git diff --name-only HEAD, so staged changes and
status metadata do not produce false new-file reports. Apply the same snapshot
logic to the corresponding after-state handling, and include untracked files if
pnpm gen can create them.
🪄 Autofix (Beta)

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: b2c8fb35-e639-41ec-b76c-4a1985eb41c1

📥 Commits

Reviewing files that changed from the base of the PR and between 5b32fe8 and 9b67d93.

📒 Files selected for processing (1)
  • web/packages/scripts/src/check-generated-files.ts

Comment thread web/packages/scripts/src/check-generated-files.ts
Signed-off-by: Sean Teramae <steramae@nvidia.com>
@steramae-nvidia
steramae-nvidia added this pull request to the merge queue Jul 20, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 20, 2026
Signed-off-by: Sean Teramae <steramae@nvidia.com>
@steramae-nvidia
steramae-nvidia added this pull request to the merge queue Jul 20, 2026
Merged via the queue into main with commit 84db18d Jul 20, 2026
62 checks passed
@steramae-nvidia
steramae-nvidia deleted the steramae/dd-docs branch July 20, 2026 23:03
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.

2 participants