Skip to content

[i18nIgnore] docs: update starlight-links-validator to version 0.7.1#1696

Merged
delucis merged 5 commits intowithastro:mainfrom
HiDeoo:hd-links-validator-0-7-1
Apr 1, 2024
Merged

[i18nIgnore] docs: update starlight-links-validator to version 0.7.1#1696
delucis merged 5 commits intowithastro:mainfrom
HiDeoo:hd-links-validator-0-7-1

Conversation

@HiDeoo
Copy link
Copy Markdown
Member

@HiDeoo HiDeoo commented Mar 29, 2024 •
edited
Loading

What kind of changes does this PR include?

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

Description

This pull request updates the documentation link checker to the version 0.7.1.

The large amount of file changed is due to the documentation using the Astro trailingSlash option with always and this new version of starlight-links-validator now ensuring that when this option is set, all links respect this option.

This finally fixes (and reliably prevents) the annoying issue when developing locally with the documentation and following some random links would result in a 404 error due to a missing trailing slash.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 29, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 403781e

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

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 29, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Apr 1, 2024 0:59am

@github-actions github-actions bot added i18n Anything to do with internationalization & translation efforts 📚 docs Documentation website changes labels Mar 29, 2024
Fryuni
Fryuni approved these changes Mar 29, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@Fryuni Fryuni left a comment

Choose a reason for hiding this comment

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

❤️

delucis
delucis approved these changes Apr 1, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Yay! This is a great change — thank you @HiDeoo!

One bit of feedback: the error message is a little bit cryptic if you’re not familiar with our trailing slash settings:

 ▶ ru/reference/plugins/
   ├─ /ru/reference/configuration - trailing slash
   └─ /ru/reference/configuration - trailing slash

It just says “trailing slash”. Something like “Missing trailing slash” or “Trailing slash required” would probably helpful to point people in the right direction when they see this error.

Nevertheless happy to approve this and get it merged before we regress on any more links!

@delucis delucis merged commit 5208c70 into withastro:main Apr 1, 2024
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request Apr 5, 2024
@HiDeoo
Merge branch 'main' into hd-draft-pages
dd2c68c 
* main: (111 commits)
  Fix various Expressive Code translation issues (withastro#1708)
  Fix nested aside title rendering issue (withastro#1703)
  I18n(pt-PT): Add resources pages (withastro#1678)
  Add SST Ion & Font Awesome to site showcase (withastro#1710)
  [ci] format
  Add SudoVanilla to showcase (withastro#1702)
  i18n(fr): Update `resources-showcase` (withastro#1697)
  [i18nIgnore] docs: update `starlight-links-validator` to version `0.7.1` (withastro#1696)
  [ci] format
  [ci] release (withastro#1688)
  [ci] format
  Update Russian translation (withastro#1616)
  [ci] format
  Adds `starlight` icon to Starlight (withastro#1698)
  Update Icons.ts with Farcaster Purple for SocialIcons (withastro#1622)
  Remove duplicate from showcase example in `contributing.md` (withastro#1692)
  i18n(zh-cn): Update `showcase.mdx` (withastro#1689)
  [ci] format
  i18n(zh-cn): Update configuration.mdx (withastro#1691)
  i18n(ko-KR): update `showcase.mdx` (withastro#1690)
  ...
@HiDeoo
Copy link
Copy Markdown
Member Author

HiDeoo commented Nov 27, 2024

One bit of feedback: the error message is a little bit cryptic if you’re not familiar with our trailing slash settings:

 ▶ ru/reference/plugins/
   ├─ /ru/reference/configuration - trailing slash
   └─ /ru/reference/configuration - trailing slash

It just says “trailing slash”. Something like “Missing trailing slash” or “Trailing slash required” would probably helpful to point people in the right direction when they see this error.

This is now available with the version 0.13.3 of the links validator. The messages would now read as:

 ▶ ru/reference/plugins/
   ├─ /ru/reference/configuration - missing trailing slash
   └─ /ru/reference/configuration/ - forbidden trailing slash

Note that I'm not gonna open a PR to update it with this new change right now as we would need to update soon anyway for some future Astro v5 changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@delucis delucis delucis approved these changes

@Fryuni Fryuni Fryuni approved these changes

Assignees

No one assigned

Labels

📚 docs Documentation website changes i18n Anything to do with internationalization & translation efforts

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@HiDeoo @delucis @Fryuni