fix(docs): repair broken links across README, docs, and templates#1847
Open
mehmetdemircs wants to merge 1 commit into
Open
fix(docs): repair broken links across README, docs, and templates#1847mehmetdemircs wants to merge 1 commit into
mehmetdemircs wants to merge 1 commit into
Conversation
Audited every URL in the repo against live HTTP, fixed two groups, and verified the pre-commit gate locally. All URLs below are clickable in the preview. ## 🔴 Group 1 — Broken (404 or wrong content) **README.md — supported-agents docs** - ❌ Before · **404** · https://www.rtk-ai.app/guide/getting-started/supported-agents - ✅ After · **200** · https://www.rtk-ai.app/docs/getting-started/supported-agents/ **README.md — configuration docs** - ❌ Before · **404** · https://www.rtk-ai.app/guide/getting-started/configuration - ✅ After · **200** · https://www.rtk-ai.app/docs/getting-started/configuration/ **`src/hooks/init.rs` (×2) and `.rtk/filters.toml` — filter template header** - ❌ Before · **page 200, anchor dead** · https://github.com/rtk-ai/rtk#custom-filters (no `## Custom Filters` heading in the README) - ✅ After · **200** · https://github.com/rtk-ai/rtk/blob/HEAD/src/filters/README.md **`docs/guide/index.md` — ARCHITECTURE.md link** - ❌ Before · **404** · https://github.com/rtk-ai/rtk/blob/master/ARCHITECTURE.md (file lives at `docs/contributing/ARCHITECTURE.md`) - ✅ After · **200** · https://github.com/rtk-ai/rtk/blob/HEAD/docs/contributing/ARCHITECTURE.md **`scripts/check-installation.sh` (×3) — install one-liner** - ❌ Before · **200 but `text/html`** · https://github.com/rtk-ai/rtk/blob/master/install.sh (GitHub HTML wrapper, fails when piped to `sh`) - ✅ After · **200 `text/plain`** · https://raw.githubusercontent.com/rtk-ai/rtk/refs/heads/master/install.sh **`.claude/agents/technical-writer.md` — Linux binary install snippet** - ❌ Before · **404** · https://github.com/rtk-ai/rtk/releases/download/v0.16.0/rtk-linux-x86_64 (asset name never existed; releases ship `.tar.gz` tarballs) - ✅ After · replaced with the official `install.sh` one-liner **`.claude/skills/ship/SKILL.md` — release verification snippet** - ❌ Before · **404** · https://github.com/rtk-ai/rtk/releases/download/v0.17.0/rtk-macos-latest (asset name never existed) - ✅ After · **200** · https://github.com/rtk-ai/rtk/releases/download/v0.17.0/rtk-aarch64-apple-darwin.tar.gz ## 🟢 Group 2 — Worked via redirect, now canonical **README.md — troubleshooting link** - 🔁 Before · **301 → /docs/resources/troubleshooting/** · https://www.rtk-ai.app/guide/troubleshooting - ✅ After · **200 direct** · https://www.rtk-ai.app/docs/resources/troubleshooting/ **README.md — docs landing link** - 🔁 Before · **301 → /docs/** · https://www.rtk-ai.app/guide - ✅ After · **200 direct** · https://www.rtk-ai.app/docs/ ## ✅ Test plan ### Pre-commit gate (per `CONTRIBUTING.md` § Testing) ```text $ cargo fmt --all --check (clean) $ cargo clippy --all-targets Finished `dev` profile [unoptimized + debuginfo] target(s) in 24.34s (0 warnings) $ cargo test test result: ok. 1869 passed; 0 failed; 6 ignored; 0 measured; 0 filtered out ``` ### Link verification Every URL above was checked with `curl -sS -L -o /dev/null -w '%{http_code}' --max-time 12 <url>` (status codes recorded inline). The `install.sh` case additionally checked `content_type` to confirm `text/html` vs `text/plain`. --- Doc-only changes — no runtime behavior altered. The only Rust file touched is `src/hooks/init.rs`, and only the URL inside two `const &str` template comments.
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.
TL;DR
Audit of every URL in the repo found 9 broken links across 7 files plus 2 README links that worked only via redirect. All fixed; doc-only changes; pre-commit gate clean (
fmt+clippy+1869 tests passed).Summary
All URLs below are clickable in the preview — click both Before and After to verify yourself.
🔴 Group 1 — Broken (404 or wrong content)
README.md — supported-agents docs
README.md — configuration docs
src/hooks/init.rs(×2) and.rtk/filters.toml— filter template header## Custom Filtersheading exists in the README)docs/guide/index.md— ARCHITECTURE.md linkdocs/contributing/ARCHITECTURE.md)scripts/check-installation.sh(×3) — install one-linertext/html· https://github.com/rtk-ai/rtk/blob/master/install.sh (GitHub's HTML wrapper page, not the script — fails when piped tosh)text/plain· https://raw.githubusercontent.com/rtk-ai/rtk/refs/heads/master/install.sh.claude/agents/technical-writer.md— Linux binary install snippet.tar.gztarballs)install.shone-liner.claude/skills/ship/SKILL.md— release verification snippet🟢 Group 2 — Worked via redirect, now canonical
README.md — troubleshooting link
README.md — docs landing link
Doc-only changes — no runtime behavior altered. The only Rust file touched is
src/hooks/init.rs, and only the URL inside twoconst &strtemplate comments (the headers written byrtk initinto a new.rtk/filters.tomlor~/.config/rtk/filters.toml).Test plan
cargo fmt --all --check— cleancargo clippy --all-targets— 0 warningscargo test— 1869 passed, 0 failed, 6 ignoredcurl -sS -L -o /dev/null -w '%{http_code}' --max-time 12 <url>install.sh(text/htmlvstext/plain) to confirm/blob/vsraw.githubusercontent.comdistinctioninstall.sh)Manual— N/A, no filter logic changedrtk <command>output inspectionPre-commit gate raw output