docs: the demo link pointed at a host that no longer resolves (#696) - #697
Merged
Conversation
`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
|
📄 Docs preview: https://11fc9baf.disarm-docs.pages.dev |
Contributor
There was a problem hiding this comment.
🟢 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.mdtohttps://disarm.dev/tools/. - Repoint the same demo link in
docs/index.mdto 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.
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.
Closes #696.
The "Try disarm in your browser" link pointed at
disarm-web.pages.dev, which no longerresolves. The demo lives at https://disarm.dev/tools/.
It was a hard failure, not a stale redirect
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:13is the crates.io, PyPI and GitHub landing copy.docs/index.md:16is thedocs.disarm.dev homepage. On both, it is the first call to action under
## Demo, sittingabove 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:
The hostname does still appear once, as prose in the
CHANGELOG.mdentry describing thisfix. 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 -rnreturnednothing, 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 --strictvalidates internal links and nav coverage, not external hosts. Noother 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 --strictexits 0 on the branch.docs.ymlis path-filtered ondocs/**, sothis PR triggers it and the same command runs in CI.
The Rust and Python gates are not run: no
.rs,.py,.tomlor table data changed, andthe three touched files are
README.md,docs/index.mdandCHANGELOG.md.