Skip to content
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

[i18nIgnore] Fix links #1039

Merged
merged 3 commits into from
Nov 6, 2023
Merged

[i18nIgnore] Fix links #1039

merged 3 commits into from
Nov 6, 2023

Conversation

delucis
Copy link
Member

@delucis delucis commented Nov 3, 2023

What kind of changes does this PR include?

  • Minor content fixes (broken links, typos, etc.)

Description

  • Fixes several broken links and makes sure links all point to the current locale (e.g. on /es/ pages, all relative links should be to /es/ versions of pages).
  • Caught the broken links with https://github.com/HiDeoo/starlight-links-validator.
  • Caught the wrong-locale links with some RegExp searching in the project (e.g. find \]\(/(?!ru) in docs/src/content/docs/ru/).

P.S. I considered if we could integrate the link checker into the docs site but HiDeoo/starlight-links-validator#9 is blocking us currently from doing that I think.

Copy link

changeset-bot bot commented Nov 3, 2023

⚠️ No Changeset found

Latest commit: 6d38dbf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Nov 3, 2023

Deploy Preview for astro-starlight ready!

Name Link
🔨 Latest commit 6d38dbf
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/6545788d100a1a0007d63f94
😎 Deploy Preview https://deploy-preview-1039--astro-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added i18n Anything to do with internationalization & translation efforts 📚 docs Documentation website changes labels Nov 3, 2023
@astrobot-houston
Copy link
Collaborator

size-limit report 📦

Path Size
/index.html 5.13 KB (0%)
/_astro/*.js 19.27 KB (0%)
/_astro/*.css 9.72 KB (0%)

Copy link
Member

@ElianCodes ElianCodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

Copy link
Member

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took a bit of time to test them all but clearly way less than it took you to fix them all. Impressive work 🤯

@delucis
Copy link
Member Author

delucis commented Nov 6, 2023

Thanks for the reviews and testing! Yeah, this is definitely something it would be nicer to stay on top of with each PR in a CI check.

@HiDeoo Saw you added the extra context HiDeoo/starlight-links-validator#9 — thank you!

@delucis delucis merged commit 5e85325 into main Nov 6, 2023
9 checks passed
@delucis delucis deleted the chris/fix-links branch November 6, 2023 20:24
@HiDeoo
Copy link
Member

HiDeoo commented Nov 6, 2023

@HiDeoo Saw you added the extra context HiDeoo/starlight-links-validator#9 — thank you!

Yeah, I also played a little bit with it this morning as I had my head in the code while releasing a new version. The logic should be relatively straightforward altho I think the smart move is to wait for plugins so I can turn the integration into a plugin and easily have access to the Starlight config to check if the site is multilingual or not and check which locales are configured.

@delucis
Copy link
Member Author

delucis commented Nov 6, 2023

the smart move is to wait for plugins so I can turn the integration into a plugin and easily have access to the Starlight config to check if the site is multilingual or not and check which locales are configured.

Absolutely. I’d also love a rule to enforce use of same-language links, which were a bunch of what I’d caught… wait I guess I should make a feature request 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Documentation website changes i18n Anything to do with internationalization & translation efforts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants