kmesh-net / kmesh-net/website

Improve documentation links and consistency

Open
#280 4 comments 0 reactions 1 assignee Claimed by @shubhtrek View on GitHub
Dominant language
JavaScript
Stars
12
Forks
75
PR merge metrics
No merged PRs in 30d

Description

### Description
While going through the documentation, I noticed a few small issues related to links and consistency that could affect readability and long-term maintenance.

### Observations
1. The Gateway API CRD installation uses a hardcoded Git commit reference, which may become outdated over time
2. The relative link `develop-with-kind/` might not always resolve correctly depending on routing
3. Some naming inconsistencies like "istio" instead of "Istio"

### Suggested Improvements
- Replace hardcoded commit references with a stable or maintained link
- Update relative links to clearer or more reliable paths
- Maintain consistent naming for technologies across the docs

### Impact
These changes would make the documentation more reliable and slightly improve the experience for new users and contributors.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.