Improve and correct links in documentation #351
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
Codecov Report
@@ Coverage Diff @@
## main #351 +/- ##
=======================================
Coverage 90.01% 90.01%
=======================================
Files 44 44
Lines 6770 6770
=======================================
Hits 6094 6094
Misses 553 553
Partials 123 123
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
umbynos
approved these changes
Mar 14, 2022
The Arduino Library Manager documentation was moved to a new location without setting up a redirect, which broke this link.
Even though these links were still reaching the intended page, it is best not to rely on redirects.
github.com and wikipedia.org have different localization behaviors depending on the URL. If a language code is specified via the URL, then that language version of the page is loaded, regardless of the language setting of the user's browser. For example, this URL will take the user to the English version of the page even if their browser is configured for Italian: https://en.wikipedia.org/wiki/Arduino If no language code is specified via the URL, then it redirects to the version of the page localized for the user's language preference, where available. For example, if the user has selected "Italian" as their preferred language in their browser settings, then this URL: https://wikipedia.org/wiki/Arduino redirects to: https://it.wikipedia.org/wiki/Arduino
The documentation hosted at arduino.github.io/arduino-cli is versioned, with the URL determining which version is loaded: - arduino.github.io/arduino-cli/0.20 - documentation content at the time of the latest release of the 0.20.x series - arduino.github.io/arduino-cli/latest - documentation content at the time of the latest release - arduino.github.io/arduino-cli/dev - documentation content at the tip of the default branch Previously, some of the links displayed to users by Arduino Lint were pointing at the "dev" version of that documentation. Since it may not apply to the release versions, or be in an unstable state, the "dev" version of the documentation should only be used by Arduino CLI developers and beta testers. For this reason, the "latest" version will be most appropriate for the users of Arduino Lint.
The Arduino Sketch Specification document has had some recent changes to avoid ambiguity. This allows the reference links to now point to the specific section of the specification relevant to that rule so that the user will be able to find the information quickly.
per1234
added
topic: documentation
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.
Fixes and enhancements identified through a comprehensive review of all links used in documentation: