docs: fix relative paths in README files #532
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EmperorOrokuSaki
requested review from
DaniPopes,
gakonst and
prestwich
as code owners
mattsse
approved these changes
Feb 17, 2024
There was a problem hiding this comment.
lgtm, ty
does this cause any sideffects on rust docs @DaniPopes
|
They're broken anyway because you can't have both rustdoc and github links work at the same time |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Since the main README.md file from the root of the repository is used in the
crates/coredir as well, the relative paths were not working. You can try to access any of the relative paths in theoverviewsection of the README.md file incrates/coreof the main repository here: https://github.com/alloy-rs/core/tree/main/crates/coreAs you notice, none of them work.
Solution
I merely changed the relative paths so that they all start at the root.
PR Checklist