Skip to content

Improve and correct links in documentation #1185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 14, 2022
Merged

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Mar 12, 2022

Fixes and enhancements identified through a comprehensive review of all links used in documentation:

  • Fix broken links
  • Configure links to allow localization where available

per1234 added 2 commits March 12, 2022 10:44
The Arduino Library Manager documentation was moved to a new location without setting up a redirect, which broke this
link.
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 or GitHub. For example, this URL will take the user to the English version of the page even if their browser is configured for Chinese:

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github

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 "Chinese" as their preferred language in their browser settings, then this URL:

https://docs.github.com/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github

redirects to:

https://docs.github.com/cn/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github
@per1234 per1234 self-assigned this Mar 12, 2022
@github-actions
Copy link
Contributor

Hi @per1234.
Your pull request has been detected as something other than a Library Manager submission.
A maintainer will need to review it before it can be merged.

If you intended to submit a library, please check the instructions and update your pull request if necessary:
https://github.com/arduino/library-registry/blob/main/README.md#instructions

@github-actions github-actions bot added the topic: other Something other than a library list request label Mar 12, 2022
@per1234 per1234 requested a review from umbynos March 12, 2022 19:00
@per1234 per1234 merged commit d29272c into arduino:main Mar 14, 2022
@per1234 per1234 deleted the update-links branch March 14, 2022 09:56
@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement type: imperfection Perceived defect in any part of project labels Mar 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project topic: other Something other than a library list request type: enhancement Proposed improvement type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants