chore(docs): retire obsolete snapshot release paths - #2247
Merged
Merged
Conversation
Derive Development previews from the canonical Fern configuration in an isolated clone. Remove per-stack folder-cut tooling and unused live product navigation while retaining archive sources and frozen release refs. Relates to #2214 Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (25)
💤 Files with no reviewable changes (10)
Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 10 remain after this review. 📝 WalkthroughWalkthroughThe pull request replaces per-stack documentation snapshots with qualified shared releases. It adds a command that stages default previews from ChangesShared documentation release flow
Priority: ⬇️ Low Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Sequence Diagram(s)sequenceDiagram
participant CI as Preview workflow
participant Helper as preview-docs
participant Clone as Temporary clone
participant Edition as edition preview
participant Fern as Fern preview
CI->>Helper: Run preview or check
Helper->>Clone: Copy docs and fern
Helper->>Edition: Derive default configuration
Edition->>Clone: Stage configuration and links
Helper->>Fern: Run preview with staged files
Suggested reviewers: Merge Risk: ⚪ Minimal · up to This change removes obsolete docs tooling and moves previews to a derived default configuration. No concrete merge-blocking risk was found in the supplied material. Hosted preview and PR CI results are still pending. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 10.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 10 functions across 5 files. (10 skipped: 10 unsupported.)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Comment |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-docs-2214-p5-cleanup.docs.buildwithfern.com/nvcf |
4 of 5 tasks
Contributor
|
This PR is included in version 1.29.2. The release is available on GitHub release. |
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.
TL;DR
P5 completes the tooling cleanup for #2214 after the 1.0.2 cutover. Remove the old per-stack folder-cut workflow and derive Development previews from the canonical Fern configuration, so site settings and redirects have one maintained source.
Additional Details
edition preview. It selects local Development, normalizes current links in a disposable clone, and preserves the canonical settings, stable refs, and archive entries. Prepared release branches use their local default.fern/navigation.yml; historical product navigation remains available.DOCS_PREVIEW_CONFIGoverrides remain available and are used as supplied.The canonical selector, release registry, current navigation, public guide content, and release branch commits are unchanged. No new release branch or registration is required for this cleanup.
For the Reviewer
Review the preview helper and new Go command/tests first, then the CI callers and guidance. The deleted configuration and freeze files are obsolete paths; retained archives still serve historical URLs.
This PR targets
mainand follows merged #2224, #2225, #2226, #2235, and #2246. It is the only remaining phase PR to review and merge. After merge, verify the normal production publisher and smoke-test the site before closing the epic.No dependency, license, or NOTICE changes. No service/runtime changes or observability impact. Customer release notes: not customer visible.
For QA
Passed locally:
tools/docs-version-syncGo tests, including preservation of site settings, release refs, archives, comments, current links, and invalid-input rejection.tools/ci/check-docs, including registered remote release checks, andtools/ci/preview-docs --checkfor the derived Development layout.Local Fern validation reports no errors and the expected unauthenticated redirect-check warning. Application QA is not needed.
Hosted validation at
7f004413822d540b706ddb5a19a442a3c320f4ac:One browser navigation timed out and succeeded on recheck; the selector test was corrected to use Fern's actual
menuitemradiorole. No source changes were needed. Search scoping remains the separate follow-up recorded in the epic; this cleanup does not change search behavior.Issues
Relates to #2214
Checklist