Skip to content

docs: the demo link pointed at a host that no longer resolves (#696) - #697

Merged
raeq merged 1 commit into
mainfrom
docs/696-demo-link
Aug 29, 2026
Merged

docs: the demo link pointed at a host that no longer resolves (#696)#697
raeq merged 1 commit into
mainfrom
docs/696-demo-link

Conversation

@raeq

@raeq raeq commented Aug 29, 2026

Copy link
Copy Markdown
Owner

Closes #696.

The "Try disarm in your browser" link pointed at disarm-web.pages.dev, which no longer
resolves. The demo lives at https://disarm.dev/tools/.

It was a hard failure, not a stale redirect

$ curl -sS -o /dev/null -w '%{http_code}\n' https://disarm.dev/tools/
200

$ curl -sS -o /dev/null -w '%{http_code}\n' https://disarm-web.pages.dev/
curl: (6) Could not resolve host: disarm-web.pages.dev

The old host fails at DNS, so no browser follows it anywhere. Every reader who clicked got a
resolution error.

It appeared twice, on the two pages read first

README.md:13 is the crates.io, PyPI and GitHub landing copy. docs/index.md:16 is the
docs.disarm.dev homepage. On both, it is the first call to action under ## Demo, sitting
above the entire "Why disarm" case — so a reader evaluating the library clicked it before
reading anything else.

Both are repointed. No link anywhere in the tree targets the old host:

$ grep -rnE '\]\(https?://disarm-web\.pages\.dev' . --exclude-dir=.git
(no matches)

The hostname does still appear once, as prose in the CHANGELOG.md entry describing this
fix. That is deliberate — a changelog entry about a dead link has to name the dead host to
be readable. An earlier draft of this description claimed a bare grep -rn returned
nothing, which was true when I ran it and false once the changelog entry landed. Corrected
here rather than by removing the hostname from the changelog.

Why no gate caught it

mkdocs build --strict validates internal links and nav coverage, not external hosts. No
other workflow checks them either. That is not a defect in the strict build — external link
checking is a different job with different failure modes, since it goes red when someone
else's site has a bad afternoon. Worth noting as a known gap rather than fixing here.

Verification

mkdocs build --strict exits 0 on the branch. docs.yml is path-filtered on docs/**, so
this PR triggers it and the same command runs in CI.

The Rust and Python gates are not run: no .rs, .py, .toml or table data changed, and
the three touched files are README.md, docs/index.md and CHANGELOG.md.

`disarm-web.pages.dev` fails at DNS, so the "Try disarm in your browser"
link was a hard error rather than a redirect a browser would follow. The
demo now lives at https://disarm.dev/tools/.

The link appeared twice, on the two pages most readers see first: README.md,
which is the crates.io and PyPI landing copy, and docs/index.md, the
docs.disarm.dev homepage. On both it is the first call to action under
`## Demo`, above the whole "Why disarm" case.

`mkdocs build --strict` validates internal links, not external hosts, and no
other job checks them — which is how this survived in those two files.

Signed-off-by: Richard Quinn <quinn.richard@gmail.com>
Assisted-by: Claude:claude-opus-5
Copilot AI lite review requested due to automatic review settings August 29, 2026 10:57
@raeq raeq added this to the 0.15.0 milestone Aug 29, 2026
@raeq raeq added the documentation Improvements or additions to documentation label Aug 29, 2026
@github-actions

Copy link
Copy Markdown

📄 Docs preview: https://11fc9baf.disarm-docs.pages.dev

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The changes are limited to documentation updates that correctly repoint the broken demo link and keep README/docs consistent.

Pull request overview

Updates the project’s primary “Demo” call-to-action links to point at the current hosted browser demo (https://disarm.dev/tools/), ensuring new readers aren’t sent to a dead host.

Changes:

  • Repoint the “Try disarm in your browser” link in README.md to https://disarm.dev/tools/.
  • Repoint the same demo link in docs/index.md to keep the docs homepage consistent with the README.
  • Add an Unreleased changelog entry documenting the fix and its impact (#696).
File summaries
File Description
README.md Updates the demo link under “## Demo” to the new canonical demo location.
docs/index.md Mirrors the README demo-link update on the docs homepage.
CHANGELOG.md Records the broken-link fix in the Unreleased “Fixed” section.
Review details
  • Files reviewed: 3/3 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CHANGELOG.md
@raeq
raeq merged commit 4c0ecc9 into main Aug 29, 2026
20 checks passed
@raeq
raeq deleted the docs/696-demo-link branch August 29, 2026 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Demo link in README and docs homepage points at a dead host (disarm-web.pages.dev)

2 participants