Skip to content

docs: Consolidate DD library docs links#673

Closed
mikeknep wants to merge 6 commits into
mainfrom
dd-docs-constant/mknepper
Closed

docs: Consolidate DD library docs links#673
mikeknep wants to merge 6 commits into
mainfrom
dd-docs-constant/mknepper

Conversation

@mikeknep

@mikeknep mikeknep commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated Data Designer documentation links to use internal library documentation paths.
    • Added redirects for Data Designer library pages to the corresponding NVIDIA documentation.
    • Removed a duplicate external “Library Documentation” link from the Next Steps section.

Signed-off-by: Mike Knepper <mknepper@nvidia.com>
@mikeknep mikeknep requested review from a team as code owners July 14, 2026 16:01
@github-actions github-actions Bot added the docs label Jul 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Data Designer overview, migration, and tutorial pages now use internal /data-designer-library/... links. A wildcard redirect maps those routes to the corresponding NVIDIA documentation URLs, and the duplicate Library Documentation card was removed.

Changes

Data Designer documentation links

Layer / File(s) Summary
Library route redirect
docs/fern/docs.yml
Adds a wildcard redirect from /data-designer-library/:slug* to the corresponding NVIDIA Data Designer documentation path.
Documentation link migration
docs/data-designer/index.mdx, docs/data-designer/migration.mdx, docs/data-designer/tutorials/*
Replaces versioned external documentation URLs with internal library routes and removes the Library Documentation card.

Possibly related PRs

Suggested reviewers: lbliii

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

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

mikeknep added 2 commits July 14, 2026 11:09
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 24401/31577 77.3% 62.0%
Integration Tests 14023/30226 46.4% 19.3%

mikeknep added 3 commits July 14, 2026 12:17
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
Move configurations between local CLI and NeMo Services execution.

</Card>
<Card title="Library Documentation" href="https://docs.nvidia.com/nemo/datadesigner/v0.7.0/getting-started/welcome">

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This card component is the only link to upstream DD docs that isn't a standard Markdown link, and it isn't especially valuable as a card here anyways, so I'm just deleting it.

Comment thread docs/fern/docs.yml

redirects:
# Upstream Data Designer library pages, targeting a specific library version
# TODO: add version path component once v0.7.0 is accessible explicitly

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Currently, the DD library only publishes the latest version of the docs with no version component at all, so we can't actually explicitly target a specific version when that version is the latest. This is getting fixed in the upstream library

Comment thread docs/fern/docs.yml
Comment on lines +26 to +27
- source: "/data-designer-library/:slug*"
destination: "https://docs.nvidia.com/nemo/datadesigner/:slug*"

@mikeknep mikeknep Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This redirect approach seems the best option for consolidating the upstream DD library links:

  • it achieves the goal of specifying the library version just once, here
  • it allows authors to write normal-looking Markdown links (don't have to use a custom <DataDesignerDocsLink> component
  • it's short

There is one unfortunate side-effect: fern's broken-links check doesn't understand redirects, and so all the DD links are flagged as broken 😒 These are currently only warnings, not errors, but still: not great. My agent suggested wrapping the broken-links check in a script that ignores the data-designer-library references. I'm tempted to punt that until we start actually blocking in CI on broken links (there is an existing one on main related to auth).

I also considered a pattern in which authors provide full-but-unversioned links in the markdown, and we use redirects to target the specific version. So for example the author would write [custom columns](https://docs.nvidia.com/nemo/datadesigner/custom-columns) and the redirect config would add in the version. Unfortunately, this does not work: you can't redirect from external sources, only from internal references (e.g. /foo); this also produced a slew of TypeErrors in Fern, including for completely unrelated links in the docs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The other weird thing about this approach is that if you right-click the link and select "Copy link address", you get the invalid, pre-redirected link. Example from the preview build:

https://nvidia-preview-dd-docs-constant-mknepper.docs.buildwithfern.com/nemo-platform/data-designer-library/getting-started/welcome

If you paste that into a browser and try to hit it, it does correctly redirect, but it's still a little weird...

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.

wow this is annoying lol. I guess it's valid technically as a link, just not to the final destination

@mikeknep mikeknep changed the title docs: Custom component for DD library docs links docs: Consolidate DD library docs links Jul 14, 2026

@mckornfield mckornfield 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.

I honestly don't know if this is an improvement with how weird it is. I will stamp it though if you feel it is hahaha

@mikeknep

Copy link
Copy Markdown
Contributor Author

Chatted in Slack and we don't like any of the options enough. In particular, the /data-designer-library/* approach looks too much like an absolute link and/or a link that should exist in the repo's docs, and therefore is more confusing than it is valuable. We'll just keep relying on grep/fastmod/agents to update all the docs links as we update lib dep versions.

@mikeknep mikeknep closed this Jul 14, 2026
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