adithya-s-k / adithya-s-k/AI-Engineering.academy
[DOCS] Navbar links in README.md do not navigate: anchor mismatch for Learning Paths, Getting Started, Community
- 主要語言
- Jupyter Notebook
- 星號
- 2.4k
- 分支
- 280
- PR 合併指標
- 30 天內沒有已合併 PR
描述
## Problem
The navbar links defined at the top of `README.md` are not navigating correctly to their respective sections.
Current navbar:
```html
Website •
Learning Paths •
Getting Started •
Community
```
However, the corresponding section headers in the README are:
```md
## 🗺️ Learning Paths
## 🚀 Getting Started
## 👥 Community
```
## Issue
`#roadmap` - No matching `id="roadmap"` or `## Roadmap` section (the section is `## 🗺️ Learning Paths`)
`#getting-started` - May not resolve correctly due to emoji in header (`## 🚀 Getting Started`)
`#community` - May not resolve correctly due to emoji in header (`## 👥 Community`)
GitHub auto-generates anchor IDs based on the rendered heading text (including emoji handling), which may not match the hardcoded navbar anchors.
## Expected Behavior
Clicking:
- Learning Paths should scroll to `## 🗺️ Learning Paths`
- Getting Started should scroll to `## 🚀 Getting Started`
- Community should scroll to `## 👥 Community`
## Suggested Fix
### Option 1 (Recommended): Update navbar anchors to match generated IDs
Inspect the generated anchor IDs on GitHub and update links accordingly. Most likely:
```html
Learning Paths
Getting Started
Community
```
> (Exact IDs should be verified from GitHub-rendered headings.)
### Option 2: Remove emojis from section headings
Change `## 🗺️ Learning Paths` to `## Learning Paths`
This ensures predictable anchor IDs:
`#learning-paths`
`#getting-started`
`#community`
### Option 3: Add explicit anchor IDs
Add manual anchors above sections:
```html
## 🗺️ Learning Paths
```
## Impact
- Improves navigation usability
- Prevents confusion for new users
- Enhances overall documentation quality
If approved, I can open a PR to fix the anchor mismatch.
貢獻指南
評估
這個 Issue 還沒有評估資料。