Skip to content

feat: mark developer portal as deprecated - #165

Merged
frankmeds merged 5 commits into
mainfrom
feat/deprecation-banner
Nov 16, 2026
Merged

frankmeds merged 5 commits into
mainfrom
feat/deprecation-banner

Conversation

@frankmeds

@frankmeds frankmeds commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

dev.zilliqa.com stays online until the migration is done, but it should be clearly marked as deprecated right away.

  • Adds a non-dismissible deprecation banner at the top of every page (content, 404 and 50x). It links to zilliqa.com and its changelog for updates.
  • Prefixes every page title with [Deprecated], so browser tabs and bookmarks show the status too.
  • Implemented as a mkdocs-material main.html override (zq2/overrides/main.html) plus banner styles in extra.css. Nothing changes in the docs content.

Banner text:

DEPRECATED This developer portal is deprecated and will stay online only until the migration is complete. Zilliqa is becoming an Ethereum Layer 2: follow zilliqa.com and the changelog for updates.

The wording follows the framing on https://www.zilliqa.com/agent.html. It doesn't name a new docs location, because none is published.

Rollout

Merging deploys to stg-dev.zilliqa.com. A release is needed for the banner to reach dev.zilliqa.com.

Testing

  • Local mkdocs build with the pinned requirements.txt (mkdocs-material 8.5.10): exit 0.
  • Checked the built HTML of index.html, endpoints/index.html and 404.html: banner present, [Deprecated] title, zilliqa.com link, no dismiss button.
  • Visual check with headless Chrome: the amber banner stays readable on the dark theme.

Also in this PR

  • CI, staging build on PRs: since DEVOPS-280, GCP workload identity only trusts refs/heads/main and releases, so "Build image with Makefile" failed on every PR at the auth step. PRs now run make build (no GCP login, no push). On main, auth, tagging and push are unchanged. Also quoted $(pwd) in the deploy step (shellcheck SC2006/SC2046).
  • Lint: zq2/overrides/main.html is structured so prettier's canonical format stays readable (prettier has no Jinja support).
  • Lint tooling: bumped trunk's trivy from v0.58.0 to v0.76.2. Upstream deleted the v0.58.0 release assets, so trunk failed with a 404 while installing it.
  • README: the "Ask DeepWiki" badge is now served from shields.io. deepwiki.com/badge.svg sits behind a Vercel bot checkpoint that answers GitHub's image proxy with a 429 HTML page, so the image never rendered.

Francesco Medas added 5 commits November 16, 2026 09:46
Add a non-dismissible deprecation banner and a [Deprecated] page-title
label to every page via a mkdocs-material main.html override. The site
stays online until the migration completes; the banner points readers
to zilliqa.com and its changelog for updates.
Prettier does not understand Jinja and reflowed the template into one
paragraph, failing trunk's fmt check. Anchor each Jinja statement next to
an HTML node, as 50x.html does, so the canonical format stays legible.
deepwiki.com/badge.svg sits behind a Vercel bot checkpoint that answers
GitHub's camo proxy with a 429 HTML page, so the image never renders.
Keep the DeepWiki link, render the badge through shields.io.
GCP workload identity now only trusts refs/heads/main and releases
(DEVOPS-280), so the staging build job failed on every pull request at
the auth step. PRs now run 'make build' to catch breakage; GCP login,
tagging and push run only on push to main. Also quote $(pwd) in the
deploy step (SC2006, SC2046).
Upstream deleted the v0.58.0 release assets, so trunk failed with a 404
while installing trivy and the Linting job broke on every run.
@frankmeds
frankmeds merged commit d7d77df into main Nov 16, 2026
4 checks passed
@frankmeds
frankmeds deleted the feat/deprecation-banner branch November 16, 2026 06:56
frankmeds added a commit that referenced this pull request Nov 16, 2026
trunk runs 'trivy config' once per file in parallel, all sharing one
--cache-dir. On a cold or day-old cache every process downloads and
unpacks the checks bundle into the same directory, and one can read it
mid-replace ('load checks: ... no such file'), failing Linting at random
(it broke on main right after #165). Backport the trunk-io/plugins
v1.10.0 definition that uses a per-run ${tmpdir} instead.

Co-authored-by: Francesco Medas <francesco@zilliqa.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant