chore(docs): use variables for docs.rs links #1098
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
Now docs.rs links are versioned using `mdbook-variables` preprocessor.
Br1ght0ne
added
documentation
Br1ght0ne
requested review from
digorithm,
iqdecay,
hal3e,
MujkicA,
segfault-magnet and
Salka1988
as code owners
This comment was marked as outdated.
This comment was marked as outdated.
Br1ght0ne
added a commit
to FuelLabs/github-actions
that referenced
this pull request
Aug 22, 2023
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.
|
what are your thoughts on creating a branch that can be used for publishing .md files in the docs that have the version applied already, and just running the docs-CI there so that the links are still checked? |
|
Another option is to use our own script in place of the preprocessor that can be run before the docs-CI. I think we should check these links somehow. |
iqdecay
previously approved these changes
Aug 31, 2023
iqdecay
previously approved these changes
Sep 10, 2023
segfault-magnet
previously approved these changes
Sep 11, 2023
digorithm
reviewed
Sep 14, 2023
Br1ght0ne
dismissed stale reviews from segfault-magnet and iqdecay
via
6a6484d
MujkicA
reviewed
Sep 29, 2023
MujkicA
approved these changes
Sep 29, 2023
iqdecay
approved these changes
Oct 4, 2023
Salka1988
approved these changes
Oct 4, 2023
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.
Close #1097.
The version replacer script will run before
mdbook-docs.ymlon CI, replacing all references to{{versions.<package>}}with the versions taken from workspace'sCargo.toml(meaning no extra files with versions involved)Checklist