docs: fix 404s on docs site via absolute paths #537
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
Currently, the README uses relative paths rather than absolute paths. This leads to 404s in two places: On https://alloy-rs.github.io/alloy/, where a link to e.g. alloy goes to https://alloy-rs.github.io/alloy/alloy/crates/alloy instead of https://github.com/alloy-rs/alloy/tree/main/crates/alloy On the Alloy crate at https://github.com/alloy-rs/alloy/tree/main/crates/alloy, where a link to e.g. alloy-signer goes to https://github.com/alloy-rs/alloy/blob/main/crates/alloy/crates/signer instead of https://github.com/alloy-rs/alloy/tree/main/crates/signer This commit fixes both of these 404s. It also follows the same usage of absolute paths as lib.rs, making the README consistent with the rest of the documentation (In addition, a newline was added for consistency with other unordered lists, but that's not really worth commenting on)
WillPapper
requested review from
DaniPopes,
gakonst,
mattsse,
onbjerg,
prestwich and
Evalir
as code owners
prestwich
approved these changes
Apr 15, 2024
ben186
pushed a commit
to ben186/alloy
that referenced
this pull request
Jul 27, 2024
Currently, the README uses relative paths rather than absolute paths. This leads to 404s in two places: On https://alloy-rs.github.io/alloy/, where a link to e.g. alloy goes to https://alloy-rs.github.io/alloy/alloy/crates/alloy instead of https://github.com/alloy-rs/alloy/tree/main/crates/alloy On the Alloy crate at https://github.com/alloy-rs/alloy/tree/main/crates/alloy, where a link to e.g. alloy-signer goes to https://github.com/alloy-rs/alloy/blob/main/crates/alloy/crates/signer instead of https://github.com/alloy-rs/alloy/tree/main/crates/signer This commit fixes both of these 404s. It also follows the same usage of absolute paths as lib.rs, making the README consistent with the rest of the documentation (In addition, a newline was added for consistency with other unordered lists, but that's not really worth commenting on)
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
Currently, the README uses relative paths rather than absolute paths. This leads to 404s in two places:
On https://alloy-rs.github.io/alloy/, where a link to e.g. alloy goes to https://alloy-rs.github.io/alloy/alloy/crates/alloy instead of https://github.com/alloy-rs/alloy/tree/main/crates/alloy
On the Alloy crate at https://github.com/alloy-rs/alloy/tree/main/crates/alloy, where a link to e.g. alloy-signer goes to https://github.com/alloy-rs/alloy/blob/main/crates/alloy/crates/signer instead of https://github.com/alloy-rs/alloy/tree/main/crates/signer
Solution
This commit fixes both of these 404s by switching from relative paths to absolute paths. It also follows the same usage of absolute paths as lib.rs, making the README consistent with the rest of the documentation.
(In addition, a newline was added for consistency with other unordered lists, but that's not really worth commenting on)
PR Checklist