Summary
The "user guide" link in README.md (Quick Start section) points to a non-existent file (docs/kmesh_demo.md), resulting in a 404 error when accessed on GitHub.
Location
- File:
README.md
- Line: 80
- Section: Quick Start
Current (broken)
Please refer to [quick start](https://kmesh.net/en/docs/setup/quick-start/) and
[user guide](docs/kmesh_demo.md) to try Kmesh quickly.
Expected (correct)
Please refer to [quick start](https://kmesh.net/en/docs/setup/quick-start/) and
[user guide](docs/en/kmesh_demo.md) to try Kmesh quickly.
Root Cause
The actual file exists at:
However, the current link is missing the en/ subdirectory, causing the path to be incorrect and leading to a broken link.
Fix
Updated the relative link in README.md to correctly reference:
Impact
- Fixes broken documentation link
- Improves onboarding experience for new users
- Prevents confusion during setup
Testing
- Verified the updated link correctly opens the user guide on GitHub
- Confirmed no other links are affected
Summary
The "user guide" link in
README.md(Quick Start section) points to a non-existent file (docs/kmesh_demo.md), resulting in a 404 error when accessed on GitHub.Location
README.mdCurrent (broken)
Expected (correct)
Root Cause
The actual file exists at:
However, the current link is missing the
en/subdirectory, causing the path to be incorrect and leading to a broken link.Fix
Updated the relative link in
README.mdto correctly reference:Impact
Testing