[Doc]: Broken relative links in example READMEs
Open
Beginner friendly
Nobody has claimed this yet.
Doc
- Dominant language
- Python
- Stars
- 14.7k
- Forks
- 2.8k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 489
Description
Two example READMEs contain broken relative links in the repository view.
examples/sample_weight_stripping/README.md:71points to../gptj, but the GPT-J example lives under../models/contrib/gptj.examples/ngram/README.md:50points to../util.py, but the shared helper file is../utils.py.
Both links currently break when you navigate the example docs in-tree.
Potential fix:
- update the
sample_weight_strippinglink to../models/contrib/gptj - update the
ngramlink to../utils.py
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with examples/sample_weight_stripping/README.md:71 and examples/ngram/README.md:50, then inspect the referenced example and helper paths in the repository. Update the two relative links and verify that both resolve correctly in the in-tree repository view.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 75/100