GoogleCloudPlatform / GoogleCloudPlatform/knowledge-catalog
use _index.md instead of index.md for fast lookup
- Dominant language
- TypeScript
- Stars
- 9.2k
- Forks
- 782
- Avg merge
- 6h 36m
- Merged PRs (30d)
- 85
Description
This is a personal suggestion:
In scenarios when people want to browser the raw files instead of chatting with agents, `index.md` is in most times mixed with other files and is hard to locate. If we rename it to `_index.md`, then it will always locate at the top of the file directory and we can quickly find it.
Contributor guide
Research direction
Search the repository for index.md files and review how they are used when browsing raw files. Check whether renaming them to _index.md affects any references or directory conventions. Done means the relevant index files are consistently renamed and raw-file browsing can locate them at the top of each directory.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- content, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100