Skip to content

fix(docs): fix broken links in README files - #1306

Closed
dcavalli wants to merge 1 commit into
rtk-ai:developfrom
dcavalli:fix/docs-broken-readme-links
Closed

dcavalli wants to merge 1 commit into
rtk-ai:developfrom
dcavalli:fix/docs-broken-readme-links

Conversation

@dcavalli

@dcavalli dcavalli commented Apr 14, 2026 •

Copy link
Copy Markdown

Summary

Repairs the broken Troubleshooting links in the 5 translated READMEs (es, fr, ja, ko, zh). Each linked to docs/TROUBLESHOOTING.md, which no longer exists after the docs were reorganized under docs/guide/. Both the header link and the Documentation-list entry now point to the actual file at docs/guide/resources/troubleshooting.md, matching the relative-path style already used for the adjacent docs/contributing/ARCHITECTURE.md link.

Note: This branch was refreshed onto the current develop (it had diverged ~2k commits and conflicted with the docs reorg). The earlier revision targeted docs/guide/troubleshooting.md, which does not exist; the correct current path is docs/guide/resources/troubleshooting.md.

5 files changed, 10 insertions, 10 deletions.

Details

A full broken-relative-link scan of every README against current develop found that only these links are broken — README.md and README_pt.md are clean (they reference the docs website rather than relative files).

File Fix (×2 occurrences each)
README_es.md docs/TROUBLESHOOTING.md → docs/guide/resources/troubleshooting.md
README_fr.md docs/TROUBLESHOOTING.md → docs/guide/resources/troubleshooting.md
README_ja.md docs/TROUBLESHOOTING.md → docs/guide/resources/troubleshooting.md
README_ko.md docs/TROUBLESHOOTING.md → docs/guide/resources/troubleshooting.md
README_zh.md docs/TROUBLESHOOTING.md → docs/guide/resources/troubleshooting.md

Test plan

  • Confirmed target docs/guide/resources/troubleshooting.md exists on current develop
  • Scanned all 7 README files for broken relative links — no remaining docs/TROUBLESHOOTING.md references
  • Verified no other relative links are broken in any README
  • CI passing; branch is mergeable (no conflicts)

@CLAassistant

CLAassistant commented Apr 14, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

The translated READMEs (es/fr/ja/ko/zh) linked Troubleshooting to
docs/TROUBLESHOOTING.md, which no longer exists after the docs were
reorganized under docs/guide/. Point both the header link and the
Documentation list entry to the actual file at
docs/guide/resources/troubleshooting.md, matching the relative-path
style already used for the adjacent ARCHITECTURE.md link.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@rtk-release-bot

Copy link
Copy Markdown
Contributor

This pull request has been automatically marked as stale due to 90 days of inactivity. If this pull request is still relevant, please leave any comment (for example, "bump"), and we'll keep it open. Your contribution is very much appreciated — we're sorry we haven't been able to review it yet.

@KuSh

KuSh commented Oct 3, 2026

Copy link
Copy Markdown
Collaborator

Closing this in favour of #2611, which fixes the same broken troubleshooting links in the five translated READMEs; it was kept because its CI ran green and it uses the live guide URL that README.md and README_pt.md already point to. If you prefer the in-repo path, a comment on #2611 is welcome, or reply here if your scope differs.

@KuSh KuSh closed this Oct 3, 2026
@KuSh KuSh added the duplicate This issue or pull request already exists label Oct 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

duplicate This issue or pull request already exists stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants