docs: fix remaining links after migration and rm temporary local link checker#2018
Merged
Conversation
Contributor
Greptile SummaryThis PR cleans up post-Fern-migration documentation debt: it adds redirect entries for legacy URL patterns, rewrites internal MDX links to use absolute Fern routes, swaps stale external URLs for working replacements, and removes the temporary local link-checker workflow, script, tests, and Makefile target.
|
| Filename | Overview |
|---|---|
| fern/docs.yml | Adds ~130 new redirect entries for legacy /about, Colang 2.0 language-reference, and private SDK helper-module URLs; updates ~30 existing destinations from stale /about/... to /about-nemo-guardrails-library/.... Changes are internally consistent and follow the documented Fern slug hierarchy. |
| nemoguardrails/tracing/constants.py | Replaces a precise YAML spec link (/gen-ai/events.yaml) with the top-level semantic-conventions landing page; otherwise no logic changes. |
| nemoguardrails/colang/v1_0/lang/comd_parser.py | Rewrites the parse_pattern docstring to avoid literal URL-like tokens (user=CURRENT, deal__status) that the link checker was flagging; no logic changes. |
| nemoguardrails/utils.py | Reformats a multi-line lambda for readability; no behavior changes. |
| docs/about/release-notes.mdx | Switches to archive.docs.nvidia.com URLs and removes the 0.14.0 entry from the Previous Releases list; the omission may be intentional (0.14.1 supersedes it) but is undocumented. |
| docs/evaluation/llm-vulnerability-scanning.mdx | Replaces broken relative static-file links with GitHub blob URLs pointing to HTML report files; blob URLs render raw HTML source rather than the rendered report in the browser. |
| docs/configure-rails/guardrail-catalog/community/fiddler.mdx | Updates three stale Fiddler docs URLs; the new anchor for 'Create a new Fiddler environment key' now points to the product overview page instead of a credentials/API-key page. |
| .github/workflows/docs-links-pr.yaml | Entire file deleted; the temporary link-checker CI job is removed as Fern's built-in checker (make docs-fern-strict) now covers this responsibility. |
| docs/configure-rails/colang/colang-2/language-reference/index.mdx | All card and list links updated from relative slugs to absolute Fern routes; changes are systematic and consistent with the slug hierarchy. |
| scripts/check-docs-links.sh | Entire 719-line script deleted; replaced by Fern's native link checker. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Incoming legacy URL] --> B{Category}
B --> C["/about/... URLs"]
B --> D["Colang 2.0 /language-reference/... URLs"]
B --> E["Private SDK helper-module URLs"]
B --> F["Sphinx /architecture, /release-notes, etc."]
C --> G["/nemo/guardrails/latest/about-nemo-guardrails-library/..."]
D --> H["/nemo/guardrails/latest/configure-guardrails/colang/colang-2/language-reference/..."]
E --> I["Nearest public SDK page\n(e.g. /guardrails-python-sdk/nemoguardrails/llm/...)"]
F --> J["Canonical Fern route\n(already existed, destination updated)"]
G --> K[Fern renders page]
H --> K
I --> K
J --> K
Reviews (6): Last reviewed commit: "Merge branch 'develop' of github.com:NVI..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
|
Staged Fern docs preview: https://nvidia-preview-pr-2018.docs.buildwithfern.com/nemo/guardrails |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
📝 WalkthroughWalkthroughThis PR removes the automated documentation link-checking infrastructure (CI workflow, shell script, tests) and refactors all documentation links throughout the codebase to use absolute site-root paths or corrected external URLs. It adds comprehensive Fern redirect rules to map legacy documentation URL patterns to the new site structure. ChangesDocumentation Link Refactoring and Infrastructure Removal
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/configure-rails/colang/colang-2/language-reference/the-standard-library.mdx`:
- Line 27: The Card component with title "LLM Flows" has a typo in its href
attribute; update the href value on the Card (the Card title="LLM Flows"
instance) from
"/configure-guardrails/colang/colang-2/language-reference/the-standard-library/lmm"
to
"/configure-guardrails/colang/colang-2/language-reference/the-standard-library/llm"
so the link points to the correct LLM Flows page.
In `@fern/docs.yml`:
- Around line 1086-1130: The destination paths in the Colang 2.0 redirect block
use the wrong prefix "configure-guardrails" — update each destination string in
the shown redirect entries so "/configure-guardrails/" is replaced with
"/configure-rails/" (i.e., change destination values for entries referencing
colang-2/language-reference/*); ensure all listed destination lines in
fern/docs.yml are updated to the correct
"/nemo/guardrails/latest/configure-rails/..." prefix.
🪄 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: a4ebd898-ea96-415b-8b45-366265978dba
📒 Files selected for processing (33)
.coderabbit.yaml.github/workflows/docs-links-pr.yamlMakefiledocs/configure-rails/colang/colang-2/getting-started/dialog-rails.mdxdocs/configure-rails/colang/colang-2/getting-started/hello-world.mdxdocs/configure-rails/colang/colang-2/getting-started/index.mdxdocs/configure-rails/colang/colang-2/getting-started/input-rails.mdxdocs/configure-rails/colang/colang-2/getting-started/multimodal-rails.mdxdocs/configure-rails/colang/colang-2/getting-started/recommended-next-steps.mdxdocs/configure-rails/colang/colang-2/index.mdxdocs/configure-rails/colang/colang-2/language-reference/index.mdxdocs/configure-rails/colang/colang-2/language-reference/make-use-of-llms.mdxdocs/configure-rails/colang/colang-2/language-reference/the-standard-library.mdxdocs/configure-rails/colang/index.mdxdocs/configure-rails/guardrail-catalog/community/ai-defense.mdxdocs/configure-rails/guardrail-catalog/community/clavata.mdxdocs/configure-rails/guardrail-catalog/community/cleanlab.mdxdocs/configure-rails/guardrail-catalog/community/fiddler.mdxdocs/configure-rails/guardrail-catalog/community/llama-guard.mdxdocs/configure-rails/guardrail-catalog/community/patronus-evaluate-api.mdxdocs/configure-rails/guardrail-catalog/content-safety.mdxdocs/configure-rails/guardrail-catalog/third-party.mdxdocs/configure-rails/guardrail-catalog/topic-control.mdxdocs/evaluation/evaluate-guardrails.mdxdocs/evaluation/llm-vulnerability-scanning.mdxdocs/getting-started/tutorials/jailbreak-detection-heuristics.mdxdocs/integration/langchain/agent-middleware.mdxdocs/resources/research.mdxdocs/telemetry.mdxfern/docs.ymlnemoguardrails/tracing/constants.pyscripts/check-docs-links.shtests/test_docs_links.py
💤 Files with no reviewable changes (3)
- scripts/check-docs-links.sh
- tests/test_docs_links.py
- .github/workflows/docs-links-pr.yaml
…/fix-remaining-links
Contributor
|
Want your agent to iterate on Greptile's feedback? Try greploops. |
tgasser-nv
approved these changes
Jun 15, 2026
tgasser-nv
left a comment
tgasser-nv
left a comment
Collaborator
There was a problem hiding this comment.
LGTM, thanks Miyoung for these fixes.
There are still 248 broken links because of a rename from configure-rails to configure-guardrails. The issue is make docs-check-redirects checks the legacy Sphynx conf.py redirects, not the new fern/docs.yml redirects. These can be fixed in a follow-on PR though, no need to block this one. Will sync up with you on this
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes the remaining broken documentation links found after the Fern migration and removes the temporary local link checker that is no longer needed.
Changes include:
/aboutURLs, old Colang 2.0 language-reference routes, legacy Sphinx routes, and generated SDK helper-module URLs that do not publish as standalone pages.Related Issue(s)
None.
Validation
make docs-fern-strictgit diff --checkChecklist
Summary by CodeRabbit
Documentation
Chores