fix: cut docs version nav from Edge so new pages aren't dropped#6349
Open
lucasgomide wants to merge 2 commits into
Open
fix: cut docs version nav from Edge so new pages aren't dropped#6349lucasgomide wants to merge 2 commits into
lucasgomide wants to merge 2 commits into
Conversation
![corridor-security[bot]](https://avatars.githubusercontent.com/in/1177339?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary: This PR updates documentation version navigation generation to clone from the Edge entry and adds corresponding documentation navigation entries/tests. No exploitable security vulnerabilities were identified.
Risk: Low risk. The changes affect documentation metadata and internal release tooling, with no new public attack surface, authentication changes, authorization logic, or sensitive data handling.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThe docs freeze flow now clones each locale’s Edge navigation for new versions, rewrites Edge-based page paths into the frozen version, and updates fixture data and tests for an Edge-only Datadog page. ChangesEdge-based docs freeze
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The docs cut copied every Edge file into the new `docs/v<X.Y.Z>/` snapshot but built that version's `docs.json` navigation by cloning the previous frozen release and only rewriting path prefixes. Pages added to Edge since the last release were therefore copied to disk yet never linked in the version selector, which is why the v1.15.0 cut shipped without the Datadog guide. `_build_new_entry` now clones the Edge nav entry and rewrites `edge/<locale>/` to `v<new>/<locale>/`, so promoting Edge to Latest carries every current page and nav restructuring.
The v1.15.0 freeze copied `enterprise/guides/datadog` into the snapshot for every locale but never linked it in `docs.json`, because the cut cloned the v1.14.7 nav instead of Edge. This backfills the missing nav reference in the `en`, `pt-BR`, `ko`, and `ar` v1.15.0 blocks so the already-shipped page is reachable from the version selector. Pairs with the `_build_new_entry` fix that prevents future cuts from dropping pages.
lucasgomide
force-pushed
the
luzk/docs-freeze-from-edge
branch
from
0ff2316 to
e15f5fe
Compare
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
1 participant
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.
The docs release cut promotes Edge → Latest, but the navigation half of that
promotion read the wrong source.
_copy_snapshotcorrectly copied everydocs/edge/<locale>/file intodocs/v<X.Y.Z>/, while_build_new_entryregistered the new version's
docs.jsonnav by cloning the previous frozenrelease and rewriting path prefixes. Any page added to Edge since the last
release was therefore written to disk but never linked in the version
selector. This is why v1.15.0 shipped without the Datadog guide
(
enterprise/guides/datadog) in all four locales, even though the files werepresent in the snapshot.
Note
Low Risk
Changes are limited to docs release tooling and Mintlify navigation entries; no runtime product, auth, or data-path impact.
Overview
Fixes a docs release bug where freezing Edge into a versioned snapshot copied files correctly but built
docs.jsonnavigation from the previous frozen release instead of Edge. Pages added to Edge after the last release (e.g. the Datadog enterprise guide) landed indocs/v<X.Y.Z>/but were missing from the version selector.The freeze tooling now clones each new version’s nav from the Edge entry and rewrites paths from
edge/<locale>/...tov<new>/<locale>/..., with pruning unchanged. A regression test covers a page present in Edge but absent from the prior release nav.Docs config: registers
enterprise/guides/datadogunder v1.15.0 for en, pt-BR, ko, and ar so that guide is discoverable in those locales.Reviewed by Cursor Bugbot for commit e15f5fe. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
New Features
Bug Fixes
Tests