Skip to content

docs: broken "user guide" link in README.md points to non-existent path #1668

@iashutoshyadav

Description

@iashutoshyadav

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:

docs/en/kmesh_demo.md

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:

docs/en/kmesh_demo.md

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

Metadata

Metadata

Labels

kind/bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions