[skip changelog] Update broken or outdated links #1833
Merged
Conversation
This file contains hidden or 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
Parts of the documentation use reference links, where the inline markup uses a label, which matches to a link reference definition elsewhere in the documentation. The major disadvantage of this approach is that unused link reference definitions are often left behind after the referencing text is removed, cluttering up the documentation and increasing the maintenance burden. That was the case here. The unused link reference definitions are hereby removed.
Some of the documentation links no longer reached their intended target. These were not caught by the Markdown link check for one of two reasons: - Redirects to a useless generic page instead of the moved specific target page - Links in non-Markdown files
Some of the links in the documentation used URLs that were redirecting to the new location of the target page. Even though these links still took the reader to the intended place eventually, it is safest to not rely on them continuing to work for the long term, so is best to update to point directly to the target.
per1234
added
topic: documentation
MatteoPologruto
approved these changes
Aug 11, 2022
cmaglie
pushed a commit
to cmaglie/arduino-cli
that referenced
this pull request
Aug 22, 2022
* [skip changelog] Remove unused link reference definitions in docs Parts of the documentation use reference links, where the inline markup uses a label, which matches to a link reference definition elsewhere in the documentation. The major disadvantage of this approach is that unused link reference definitions are often left behind after the referencing text is removed, cluttering up the documentation and increasing the maintenance burden. That was the case here. The unused link reference definitions are hereby removed. * [skip changelog] Fix broken links in documentation Some of the documentation links no longer reached their intended target. These were not caught by the Markdown link check for one of two reasons: - Redirects to a useless generic page instead of the moved specific target page - Links in non-Markdown files * [skip changelog] Update documentation links that depend on redirects Some of the links in the documentation used URLs that were redirecting to the new location of the target page. Even though these links still took the reader to the intended place eventually, it is safest to not rely on them continuing to work for the long term, so is best to update to point directly to the target.
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Documentation fix
What is the current behavior?
Some of the links in the documentation are broken (in ways or forms that are not covered by the automated link check).
Some of the links in the documentation rely on redirects which could break in the future.
What is the new behavior?
All links in documentation reach their intended target, and reach it directly.
Does this PR introduce a breaking change
No breaking change.
Other information
Fixes #1832