docs(mlc): ignore versioned docs.rs links used by fuels-rs book #19
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
In FuelLabs/fuels-rs#1098, a new format for documentation links in `fuels-rs` book is introduced to allow for versioned Rust docs links. Examples: - `docs.rs/fuels/{{versions.fuels}}/fuels/...` - `docs.rs/fuels-types/{{versions.fuels_types}}/fuels-types/...` These variables will be replaced with actual versions at build time. However, the link checker (MLC) runs on `.md` files before the build, and as such flags these links as incorrect. My current solution is to ignore these links in the checker for now, unless some post-build checking (or similar) is implemented at a later date.
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.
In FuelLabs/fuels-rs#1098, a new format for documentation links in
fuels-rsbook is introduced to allow for versioned Rust docs links. Examples:docs.rs/fuels/{{versions.fuels}}/fuels/...docs.rs/fuels-types/{{versions.fuels_types}}/fuels-types/...These variables will be replaced with actual versions at build time. However, the link checker (MLC) runs on
.mdfiles before the build, and as such flags these links as incorrect.My current solution is to ignore these links in the checker for now, unless some post-build checking (or similar) is implemented at a later date.