Skip to content

fix(docs): update broken troubleshooting links in translated READMEs - #2611

Open
guyoron1 wants to merge 2 commits into
rtk-ai:developfrom
guyoron1:fix/readme-ko-troubleshooting-link
Open

guyoron1 wants to merge 2 commits into
rtk-ai:developfrom
guyoron1:fix/readme-ko-troubleshooting-link

Conversation

@guyoron1

@guyoron1 guyoron1 commented Jun 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Replace broken docs/TROUBLESHOOTING.md references with the live guide URL (https://www.rtk-ai.app/guide/troubleshooting) across all translated READMEs
  • Fixes README_ko.md, README_es.md, README_fr.md, README_ja.md, and README_zh.md: both the navigation header link and the documentation section link
  • Localize link text from the English filename to each language's native label (e.g. TROUBLESHOOTING.md -> 문제 해결, 故障排除, etc.)
  • Matches the main README.md and README_pt.md, which already use the live URL

docs/TROUBLESHOOTING.md was removed in the April docs consolidation (a94e949), so these links 404 on develop.

Fixes #2561

Test plan

  • Link check over every README*.md (resolves files and #anchors): 10 broken relative links on develop (all docs/TROUBLESHOOTING.md, two per translated README), 0 after this change
  • https://www.rtk-ai.app/guide/troubleshooting returns HTTP 200; the old github.com/rtk-ai/rtk/blob/develop/docs/TROUBLESHOOTING.md returns 404
  • README-only diff; git diff --check and scripts/check-test-presence.sh clean

Overlaps #1306, #2623 and #3834, which fix the same links using the in-repo docs/guide/resources/troubleshooting.md instead of the live URL. Which target is preferred is a maintainer call; happy to switch.

@guyoron1
guyoron1 force-pushed the fix/readme-ko-troubleshooting-link branch from 302fbda to 098a1fd Compare August 14, 2026 19:03
Replace local docs/TROUBLESHOOTING.md references with the live
guide URL, matching the main README.

Fixes rtk-ai#2561
Apply the same fix from README_ko.md to README_es.md, README_fr.md,
README_ja.md, and README_zh.md — replace local docs/TROUBLESHOOTING.md
references with the live guide URL and localize the link text.
@guyoron1
guyoron1 force-pushed the fix/readme-ko-troubleshooting-link branch from 098a1fd to aca2370 Compare September 21, 2026 12:20
@guyoron1

Copy link
Copy Markdown
Contributor Author

Rebased on current develop, no conflicts. docs/TROUBLESHOOTING.md went away in the April docs consolidation, so the nav link and the Documentation link in the es/fr/ja/ko/zh READMEs still 404. Both now point at https://www.rtk-ai.app/guide/troubleshooting, the target README.md and README_pt.md already use and what #2561 asks for. I ran a link check over every README*.md: 10 broken relative links before, 0 after.

This overlaps #1306, #2623 and #3834, which fix the same links using the in-repo docs/guide/resources/troubleshooting.md instead of the live URL. Which target is preferred is a maintainer call, and I'm happy to switch.

@KuSh KuSh mentioned this pull request Oct 3, 2026
4 tasks done
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.

Fix wrong reference in README_ko.md

1 participant