Skip to content

fix: update outdated links in upgrade/version-guides#189

Merged
dreyfus92 merged 3 commits into
withstudiocms:mainfrom
ArmandPhilippot:fix/404-link
Dec 21, 2025
Merged

fix: update outdated links in upgrade/version-guides#189
dreyfus92 merged 3 commits into
withstudiocms:mainfrom
ArmandPhilippot:fix/404-link

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Dec 21, 2025

Description

There was two links targeting the web-vitals page which is now removed. I removed them since they are not used on these pages.

Summary by CodeRabbit

  • Documentation
    • Updated external links in the 0-1-0-beta-20 and 0-1-0-beta-21 upgrade guides: removed the web-vitals-guide link and adjusted the formatting of the effect-website link (no URL change).

✏️ Tip: You can customize this high-level summary in your review settings.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner December 21, 2025 20:29
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 21, 2025

📝 Walkthrough

Walkthrough

Removed the web-vitals-guide external link entries from two upgrade guide files and applied a minor formatting change to the effect-website external link line; no code or API changes.

Changes

Cohort / File(s) Summary
Link edits in upgrade guides
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx, src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx
Removed the web-vitals-guide link from the Links/External Links block in both files; adjusted formatting of the effect-website link entry (no URL/content change).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Check that removing the web-vitals-guide link was intentional and not required elsewhere.
  • Confirm effect-website link formatting change didn't introduce markdown rendering issues.

Possibly related PRs

Suggested reviewers

  • louisescher

Poem

🐰 A nibble at links, a tidy little hop,
Lines rearranged, then I stopped to hop.
Removed a path, smoothed a string,
Docs gleam bright — let the changelog sing! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: removing outdated links from the upgrade/version-guides documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Dec 21, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/upgrade/version-guides/0-1-0-beta-20.mdx Source changed, localizations will be marked as outdated.
en/guides/upgrade/version-guides/0-1-0-beta-21.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1)

29-29: Remove unused link reference.

The [web-vitals-guide] reference is defined but never used in this document. Unlike the beta-19 guide where this reference was actively used, the content referencing it has been removed in beta-20. This creates unnecessary maintenance overhead.

Remove line 29: [web-vitals-guide]: /en/package-catalog/

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e9b3d6 and 94f2433.

📒 Files selected for processing (2)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1 hunks)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
📚 Learning: 2025-07-21T12:16:32.374Z
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.

Applied to files:

  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build-and-push
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (3)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1)

32-32: LGTM - formatting change only.

This appears to be a formatting-only change (likely newline at end of file) with no functional impact on the external link.

src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx (2)

32-32: No action needed—the external link is valid and accessible.

The Effect website (effect.website) is live and functioning, serving as the official documentation for the Effect TypeScript library. The reference link syntax is correct.


29-29: The link reference definition is correct and properly formatted. The target path /en/package-catalog/ exists and is consistent with beta-20. The reference definition is maintained for consistency across version guides, following the established documentation pattern.

Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

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

nice catch! 👀

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx (1)

31-31: Approve changes and remove unused effect-website link definition.

The removal of the web-vitals-guide link addresses the PR objective to eliminate outdated/404 links, and the formatting adjustment (newline at EOF) follows best practices.

The effect-website link definition on line 31 is unused throughout the document and should be removed as dead code:

{/* External Links */}
[config-doc]: /en/config-reference/
[image-service]: /en/config-reference/features/#preferredimageservice
[cloudinary-plugin]: /en/package-catalog/studiocms-plugins/studiocms-cloudinary-js/
-[effect-website]: https://effect.website
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 94f2433 and d38d58a.

📒 Files selected for processing (2)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1 hunks)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-21.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-20.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Run Starlight Link Check
  • GitHub Check: build-and-push

@dreyfus92 dreyfus92 merged commit 729ffaa into withstudiocms:main Dec 21, 2025
8 of 9 checks passed
@ArmandPhilippot ArmandPhilippot deleted the fix/404-link branch December 21, 2025 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants