Add deprecated banner to Splice docs#5446
Draft
danielporterda wants to merge 1 commit intocanton-network:mainfrom
Draft
Add deprecated banner to Splice docs#5446danielporterda wants to merge 1 commit intocanton-network:mainfrom
danielporterda wants to merge 1 commit intocanton-network:mainfrom
Conversation
cee40e3 to
c9050e5
Compare
Contributor
|
@danielporterda |
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.
Summary
Adds a global deprecated-site banner to the Splice Sphinx docs published at
docs.sync.global.The banner is injected through the shared Sphinx layout so normal docs pages, search, and generated index pages all receive the notice. The only generated HTML files without the banner in the smoke build are the two
sphinx-reredirectsredirect stubs, which immediately redirect tosv_helm.html, where the banner is present.The visual treatment now reuses the Canton Network docs brand palette from
digital-asset/cf-docs(#734BE2,#5C3DB8, and a light lavender surface) rather than a generic warning-orange style.Design artifacts
Screenshots
Desktop overview page
Shows the deprecated banner below the existing breadcrumbs/edit area and above the page heading, using the Canton Network docs purple/lavender brand treatment.
Mobile overview page
Shows the banner stacked for narrow viewports with the call-to-action still visible before the deprecated page content.
Validation
git diff --checksphinx-build -b html -q docs/src /tmp/splice-docs-banner-smokesv_operator/bootstrap.htmlandsv_operator/onboarding.html.index.html,search.html,genindex.html, andoverview/overview.htmlinclude the banner and stylesheet.Note: I attempted to use the repo
direnv/Nix shell first. The worktree.envrcneeded flakes enabled, and after settingNIX_CONFIG='extra-experimental-features = nix-command flakes',nix print-dev-envdid not finish materializing the dev shell in a practical window. The smoke build above uses the same Sphinx config path but does not run the repo's fullsbt docs/bundle, so it reports existing warnings for generated Daml API and metrics pages that are normally produced by the full bundle task.