Skip to content

Add a site-wide zcashd end-of-support notice - #15

Open
bloxster wants to merge 1 commit into
zodl-inc:masterfrom
bloxster:docs/zcashd-eol-notice
Open

Add a site-wide zcashd end-of-support notice#15
bloxster wants to merge 1 commit into
zodl-inc:masterfrom
bloxster:docs/zcashd-eol-notice

Conversation

@bloxster

Copy link
Copy Markdown

zcashd halted at its hard-coded deprecation height on 18 July 2026 — 6.20.0 at block 3,417,100 — and refuses to restart. It does not support NU6.3 (Ironwood), which has since activated on mainnet.

This site carries no notice of that anywhere.

Why a template override rather than page edits. 21 pages here reference zcashd or zcash-cli three or more times. Editing some and not others draws a line that is hard to defend, and a large diff is harder to review and revert. This instead overrides the theme's document block once, which renders the notice on every page and touches no content at all. Deleting source/ntemplates/layout.html removes it completely.

It follows the pattern already established by ntemplates/breadcrumbs.html and uses the existing templates_path, so there is no conf.py change.

Verification.

  • {% block document %} is present in sphinx-rtd-theme 0.5.0 (layout.html line 194) — the version pinned in source/requirements.txt
  • A build with the override emits the notice once per page, ahead of the body, with no new warnings
  • All four linked URLs return 200

On wording. I deliberately kept this factual and narrow. It states what happened, points at Zebra and Zallet and at your own deprecation and end-of-life pages, and says only "Much of this site predates that transition" rather than characterising the state of the docs on your behalf. It also avoids asserting an activation date, since the end-of-life page describes 28 July as estimated.

This is the one of my four PRs that carries an editorial judgement rather than a straightforward repair, so I am entirely happy for it to become a discussion instead of a merge — including "we want a notice, but differently worded" or "we would rather do this ourselves". Tell me which and I will adjust or close it.

zcashd halted at its hard-coded deprecation height on 18 July 2026 (6.20.0 at
block 3,417,100) and does not support NU6.3, which has since activated. Most of
this site documents zcashd, and 21 pages reference it three or more times, so a
per-page banner would be both a large diff and an arbitrary line to draw.

This overrides the theme's document block instead, rendering the notice on
every page without touching any content. It follows the pattern of
ntemplates/breadcrumbs.html and the existing templates_path. Deleting the file
removes the notice.

{% block document %} is present in sphinx-rtd-theme 0.5.0, the pinned version
(layout.html line 194). All four linked URLs return 200.
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