Add Dual-Running Deprecation Notice Banner to Documentation Pages - #7
Merged
Conversation
Adds the Figma "Banner / Dual-running" notice above the ReDoc documentation,
pointing users at the new developer portal ahead of the 31-Dec-2026 cutover.
index.html:
- banner styles, markup and a height-sync script, all namespaced `op-banner`
- offset overrides so the MUI AppBar, the ReDoc sidebar and the content
column shift down by the banner height
- the script keeps `--op-banner-h` in sync with the banner's real rendered
height, which grows when the copy wraps on narrow viewports (100px at
desktop, ~204px at 375px wide)
static/js/main.ffea48a5.chunk.js:
- `scrollYOffset` changed from the hardcoded 64 to a function returning the
AppBar's live bottom edge. ReDoc uses this value for both the sticky
sidebar `top` and anchor scrolling, so with a banner above it every
sidebar click landed the target heading ~81px underneath the header.
CSS cannot reach it. Reverting this single literal reproduces the previous
bundle byte-for-byte.
Note: this repo is build output, so both changes are overwritten by the next
release build. See BANNER.md.
Outstanding: the CTA label is still a placeholder ("Go to the new
documentation") pending the exact wording, and the #101828 background is
inferred rather than confirmed.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
prasad-fernando-74
requested review from
vkolosovski
and
a lite review from Copilot
August 27, 2026 09:14
There was a problem hiding this comment.
Pull request overview
Adds a “dual-running” migration notice banner above the existing ReDoc-based API documentation, and adjusts layout/scroll behavior so the AppBar, sidebar, and anchor scrolling remain aligned with the new banner height.
Changes:
- Injects an
op-banner(styles + markup + height-sync script) intoindex.htmland shifts existing UI down by the banner height. - Updates ReDoc’s
scrollYOffsetin the built JS bundle to use the AppBar’s live bottom edge instead of a hardcoded offset. - Adds
BANNER.mddocumenting that these changes are build-artifact edits that must be re-applied after each release build.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| index.html | Adds the banner + CSS offset overrides + script that syncs --op-banner-h. |
| static/js/main.ffea48a5.chunk.js | Adjusts ReDoc scrollYOffset to account for banner/AppBar offset dynamically. |
| BANNER.md | Documents the approach, rationale, and known follow-ups for the banner change. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Adds the Figma "Banner / Dual-running" notice above the ReDoc documentation, pointing users at the new developer portal ahead of the 31-Dec-2026 cutover.
index.html:
op-banner--op-banner-hin sync with the banner's real rendered height, which grows when the copy wraps on narrow viewports (100px at desktop, ~204px at 375px wide)static/js/main.ffea48a5.chunk.js:
scrollYOffsetchanged from the hardcoded 64 to a function returning the AppBar's live bottom edge. ReDoc uses this value for both the sticky sidebartopand anchor scrolling, so with a banner above it every sidebar click landed the target heading ~81px underneath the header. CSS cannot reach it. Reverting this single literal reproduces the previous bundle byte-for-byte.Note: this repo is build output, so both changes are overwritten by the next release build. See BANNER.md.
Outstanding: the CTA label is still a placeholder ("Go to the new documentation") pending the exact wording, and the #101828 background is inferred rather than confirmed.