Skip to content

Fix/broken doc links#1

Merged
mookechee merged 3 commits intomasterfrom
fix/broken-doc-links
Jan 17, 2026
Merged

Fix/broken doc links#1
mookechee merged 3 commits intomasterfrom
fix/broken-doc-links

Conversation

@mookechee
Copy link
Owner

@mookechee mookechee commented Jan 17, 2026

Summary of this pull request

Does this solve an existing issue? If so, add a link to it

Steps to test this feature

Screenshots

Additional info

Summary by CodeRabbit

  • Documentation
    • Made language switcher labels clickable links in README files for improved navigation
    • Updated documentation paths and reference links across multiple README variants
    • Reorganized resource paths to reflect current file structure
    • Improved accessibility of language and configuration documentation links

✏️ Tip: You can customize this high-level summary in your review settings.

Copilot AI review requested due to automatic review settings January 17, 2026 03:39
@coderabbitai
Copy link

coderabbitai bot commented Jan 17, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Documentation links across multiple README files are updated to convert plain text language labels to hyperlinks and adjust file paths, primarily moving references from Resources/ subdirectory to root-level locations.

Changes

Cohort / File(s) Summary
Language link conversion in Lite READMEs
Resources/README-Lite.md, Resources/README-Lite-de.md, Resources/README-Lite-zh.md
Convert language labels from plain text to hyperlinks pointing to respective Lite README files (English, Deutsch, Chinese). Each file updated with 1 line change.
Main language-specific READMEs with path updates
Resources/README-de.md, Resources/README-tr.md, Resources/README-zh.md
Update link targets and paths: move references from Resources/ subdirectory to root-level files; add Deutsch language link in Turkish README; adjust image source paths from Resources/Support-*.jpg to root-level equivalents. Total 9 lines changed across 3 files.
Root README language link
README.md
Convert English language label to hyperlink pointing to README.md. Single line change.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Links hop to their rightful places, files reorganized with care,
Path redirects dance from Resources to root, documentation fresh in the air,
Language labels now clickable with a bound—the README network thrives!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mookechee mookechee merged commit 245e05d into master Jan 17, 2026
4 of 5 checks passed
@mookechee mookechee deleted the fix/broken-doc-links branch January 17, 2026 03:39
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request fixes broken documentation links across multiple README files in different languages. The primary issue was incorrect relative paths that included an extra ./Resources/ prefix when linking between files already in the Resources directory.

Changes:

  • Corrected relative paths in all internationalized README files by removing redundant ./Resources/ prefixes
  • Added self-referential links for current language indicators in language navigation menus
  • Replaced references to non-existent Turkish Lite documentation with German Lite documentation

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
Resources/README-zh.md Fixed self-referencing link for Chinese and corrected config documentation path
Resources/README-tr.md Corrected cross-reference paths and replaced missing Turkish Lite links with German
Resources/README-de.md Fixed cross-reference paths, added self-reference, and corrected image paths
Resources/README-Lite.md Added self-referential link for English language indicator
Resources/README-Lite-zh.md Added self-referential link for Chinese language indicator
Resources/README-Lite-de.md Added self-referential link for German language indicator
README.md Added self-referential link for English language indicator

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

<div align="center">
<img width="80%" src="https://user-images.githubusercontent.com/11001224/104892170-d18f2b80-59ac-11eb-96b1-0293acfde4e5.png"><br/><br/>
<a href="../README.md">English</a> | 中文
<a href="../README.md">English</a> | <a href="./README-zh.md">中文</a>
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

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

The Chinese README is referencing its own file in the language navigation links. While this doesn't break functionality, it creates a non-clickable link for the current language. Consider using plain text instead of a self-referential link for better user experience.

Suggested change
<a href="../README.md">English</a> | <a href="./README-zh.md">中文</a>
<a href="../README.md">English</a> | 中文

Copilot uses AI. Check for mistakes.
<div align="center">
<img width="100%" src="https://user-images.githubusercontent.com/11001224/104892184-d522b280-59ac-11eb-9c06-5ffd044dce7d.png"><br/><br/>
English | <a href="./README-Lite-zh.md">中文</a> | <a href="./README-Lite-de.md">Deutsch</a>
<a href="./README-Lite.md">English</a> | <a href="./README-Lite-zh.md">中文</a> | <a href="./README-Lite-de.md">Deutsch</a>
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

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

The Lite English README is referencing its own file in the language navigation links. While this doesn't break functionality, it creates a non-clickable link for the current language. Consider using plain text instead of a self-referential link for better user experience.

Suggested change
<a href="./README-Lite.md">English</a> | <a href="./README-Lite-zh.md">中文</a> | <a href="./README-Lite-de.md">Deutsch</a>
English | <a href="./README-Lite-zh.md">中文</a> | <a href="./README-Lite-de.md">Deutsch</a>

Copilot uses AI. Check for mistakes.
<div align="center">
<img width="100%" src="https://user-images.githubusercontent.com/11001224/104892184-d522b280-59ac-11eb-9c06-5ffd044dce7d.png"><br/><br/>
<a href="./README-Lite.md">English</a> | 中文 | <a href="./README-Lite-de.md">Deutsch</a>
<a href="./README-Lite.md">English</a> | <a href="./README-Lite-zh.md">中文</a> | <a href="./README-Lite-de.md">Deutsch</a>
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

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

The Lite Chinese README is referencing its own file in the language navigation links. While this doesn't break functionality, it creates a non-clickable link for the current language. Consider using plain text instead of a self-referential link for better user experience.

Suggested change
<a href="./README-Lite.md">English</a> | <a href="./README-Lite-zh.md">中文</a> | <a href="./README-Lite-de.md">Deutsch</a>
<a href="./README-Lite.md">English</a> | 中文 | <a href="./README-Lite-de.md">Deutsch</a>

Copilot uses AI. Check for mistakes.
<div align="center">
<img width="80%" src="https://user-images.githubusercontent.com/11001224/104892170-d18f2b80-59ac-11eb-96b1-0293acfde4e5.png"><br/><br/>
English | <a href="./Resources/README-zh.md">中文</a> | <a href="./Resources/README-tr.md">Türkçe</a> | <a href="./Resources/README-de.md">Deutsch</a>
<a href="./README.md">English</a> | <a href="./Resources/README-zh.md">中文</a> | <a href="./Resources/README-tr.md">Türkçe</a> | <a href="./Resources/README-de.md">Deutsch</a>
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

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

The main README is referencing its own file in the language navigation links. While this doesn't break functionality, it creates a non-clickable link for the current language. Consider using plain text instead of a self-referential link for better user experience.

Suggested change
<a href="./README.md">English</a> | <a href="./Resources/README-zh.md">中文</a> | <a href="./Resources/README-tr.md">Türkçe</a> | <a href="./Resources/README-de.md">Deutsch</a>
English | <a href="./Resources/README-zh.md">中文</a> | <a href="./Resources/README-tr.md">Türkçe</a> | <a href="./Resources/README-de.md">Deutsch</a>

Copilot uses AI. Check for mistakes.
</p>

English | [OpenInTerminal 中文说明](./Resources/README-zh.md) | [OpenInTerminal Türkçe](./Resources/README-tr.md)
[English](../README.md) | [OpenInTerminal 中文说明](./README-zh.md) | [OpenInTerminal Türkçe](./README-tr.md) | [OpenInTerminal Deutsch](./README-de.md)
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

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

The Turkish README is referencing its own file in the language navigation links. While this doesn't break functionality, it creates a non-clickable link for the current language. Consider using plain text instead of a self-referential link for better user experience, similar to how some of the other language files handle the current language indicator.

Suggested change
[English](../README.md) | [OpenInTerminal 中文说明](./README-zh.md) | [OpenInTerminal Türkçe](./README-tr.md) | [OpenInTerminal Deutsch](./README-de.md)
[English](../README.md) | [OpenInTerminal 中文说明](./README-zh.md) | OpenInTerminal Türkçe | [OpenInTerminal Deutsch](./README-de.md)

Copilot uses AI. Check for mistakes.
</p>

[English](../README.md) | [OpenInTerminal 中文说明](./Resources/README-zh.md) | [OpenInTerminal Türkçe](./Resources/README-tr.md) | OpenInTerminal Deutsch
[English](../README.md) | [OpenInTerminal 中文说明](./README-zh.md) | [OpenInTerminal Türkçe](./README-tr.md) | [OpenInTerminal Deutsch](./README-de.md)
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

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

The German README is referencing its own file in the language navigation links. While this doesn't break functionality, it creates a non-clickable link for the current language. Consider using plain text instead of a self-referential link for better user experience, similar to how some of the other language files handle the current language indicator.

Suggested change
[English](../README.md) | [OpenInTerminal 中文说明](./README-zh.md) | [OpenInTerminal Türkçe](./README-tr.md) | [OpenInTerminal Deutsch](./README-de.md)
[English](../README.md) | [OpenInTerminal 中文说明](./README-zh.md) | [OpenInTerminal Türkçe](./README-tr.md) | OpenInTerminal Deutsch

Copilot uses AI. Check for mistakes.
</p>

[English](./README-Lite.md) | [中文说明](./README-Lite-zh.md) | Deutsch
[English](./README-Lite.md) | [中文说明](./README-Lite-zh.md) | [Deutsch](./README-Lite-de.md)
Copy link

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

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

The German Lite README is referencing its own file in the language navigation links. While this doesn't break functionality, it creates a non-clickable link for the current language. Consider using plain text instead of a self-referential link for better user experience, similar to how the original versions handled the current language indicator.

Suggested change
[English](./README-Lite.md) | [中文说明](./README-Lite-zh.md) | [Deutsch](./README-Lite-de.md)
[English](./README-Lite.md) | [中文说明](./README-Lite-zh.md) | Deutsch

Copilot uses AI. Check for mistakes.
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.

2 participants