Every relative link in README.md is a 404 on all nine crates.io pages
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github-actions, rust
- Domain
- ci-cd, documentation
Research direction
Start with the workspace README.md and inspect its relative links, then locate the crate-metadata check and the gate that runs it. Replace the broken targets with absolute GitHub links and make the check reject relative links. Done when the published README links resolve and the check runs in the gate.
Written by the indexing model from the issue text.
Description
Today — each crate's readme is the workspace README, and crates.io resolves its relative links against the crate's own directory, so all 27 distinct relative targets break on crates.io:
https://github.com/vyncint/oxidelake/blob/HEAD/crates/oxidelake-api/CHANGELOG.md 404
https://github.com/vyncint/oxidelake/blob/HEAD/crates/oxidelake-api/CONTRIBUTING.md 404
https://github.com/vyncint/oxidelake/blob/HEAD/crates/oxidelake-api/crates/oxidelake-api 404
(launchbound 2.2.1 and termlens 0.10.3 fixed the same thing.)
Fix — absolute https://github.com/vyncint/oxidelake/blob/main/… links in README, and a crate-metadata check that fails on a relative link.
Done when — the published README's links resolve; the check is in the gate.
Found in the 0.3.0 review; published 0.2.0 has the same code.
- Dominant language
- Rust
- Stars
- 1
- Forks
- 2
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from vyncint/oxidelake
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
bug github_actions
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug github_actions
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug github_actions
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
bug github_actions
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
All issues in vyncint/oxidelake
Similar issues
-
bug duplicate priority: low ui
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
storytold/vectorcraft#6956 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug multiple issues priority: high
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
storytold/gridcraft#3928 · 1 comment ·
Maintainers usually reply within 1 day
-
crate-drift
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
po4yka/rust-skills#33 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
svix/svix-webhooks#2808 ·
Maintainers usually reply within 1 day