Skip to content

Conversation

danielroe
Copy link
Member

🔗 Linked issue

📚 Description

more fixes

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot added the 4.x label Sep 18, 2025
Copy link

coderabbitai bot commented Sep 18, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation-only updates across many markdown files: numerous in-page anchor links were replaced with absolute documentation paths or had minor URL formatting changes. Minor wording edits were made in the View Transitions doc (consolidated demo link, reworded enabling sentence). Additionally, lychee.toml was modified: base renamed to base_url (with trailing slash), accepted HTTP status codes expanded, fragment checking enabled, redirect and retry/timeouts configured, user agent set, and one URL added to the exclude list. No code, API signatures, or runtime behaviour changes were introduced.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description Check ❓ Inconclusive The PR description contains only a linked-issue placeholder and the brief phrase "more fixes", which is related to the changeset but is very generic and does not describe which files or links were changed. Under the check's guidance this level of vagueness is inconclusive because it provides insufficient context for reviewers to understand the intent without inspecting each file. The description therefore needs clarification before merging. Please update the PR description to reference any related issue number (or remove the placeholder) and add a short summary of the edits, for example: "Fix links in docs/1.getting-started/09.transitions.md and docs/2.guide/1.concepts/7.esm.md — replace surge.sh demo link with StackBlitz and add trailing slash to ESM URL." This will give reviewers quick context and speed up the review.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "docs: fix some links" accurately summarises the primary change in this PR, which is focused on correcting and simplifying documentation links across the repo (e.g. edits to docs/1.getting-started/09.transitions.md and docs/2.guide/1.concepts/7.esm.md). It is concise, relevant, and clear enough for a teammate scanning history to understand the main intent. The phrasing avoids noise and correctly highlights the most important change.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 752113a and 39751ca.

📒 Files selected for processing (31)
  • docs/1.getting-started/03.configuration.md (1 hunks)
  • docs/1.getting-started/05.assets.md (1 hunks)
  • docs/1.getting-started/08.seo-meta.md (1 hunks)
  • docs/1.getting-started/10.data-fetching.md (6 hunks)
  • docs/1.getting-started/12.error-handling.md (4 hunks)
  • docs/1.getting-started/17.testing.md (1 hunks)
  • docs/2.guide/1.concepts/1.auto-imports.md (1 hunks)
  • docs/2.guide/1.concepts/3.rendering.md (2 hunks)
  • docs/2.guide/1.concepts/4.server-engine.md (1 hunks)
  • docs/2.guide/1.concepts/7.esm.md (3 hunks)
  • docs/2.guide/2.directory-structure/1.app/1.components.md (1 hunks)
  • docs/2.guide/2.directory-structure/1.app/1.pages.md (2 hunks)
  • docs/2.guide/2.directory-structure/1.server.md (1 hunks)
  • docs/2.guide/2.directory-structure/1.shared.md (1 hunks)
  • docs/2.guide/3.going-further/3.modules.md (2 hunks)
  • docs/3.api/1.components/4.nuxt-link.md (1 hunks)
  • docs/3.api/2.composables/use-async-data.md (1 hunks)
  • docs/3.api/2.composables/use-fetch.md (1 hunks)
  • docs/3.api/2.composables/use-nuxt-app.md (2 hunks)
  • docs/3.api/3.utils/define-page-meta.md (2 hunks)
  • docs/3.api/5.kit/3.compatibility.md (2 hunks)
  • docs/3.api/5.kit/5.components.md (2 hunks)
  • docs/3.api/5.kit/8.layout.md (1 hunks)
  • docs/3.api/6.advanced/1.hooks.md (1 hunks)
  • docs/5.community/4.contribution.md (4 hunks)
  • docs/5.community/5.framework-contribution.md (1 hunks)
  • docs/5.community/6.roadmap.md (1 hunks)
  • docs/6.bridge/3.bridge-composition-api.md (1 hunks)
  • docs/6.bridge/5.nuxt3-compatible-api.md (1 hunks)
  • docs/7.migration/2.configuration.md (1 hunks)
  • lychee.toml (2 hunks)

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.

Copy link

@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: 1

🧹 Nitpick comments (2)
docs/2.guide/1.concepts/7.esm.md (1)

35-35: Link tweak looks good; tiny grammar polish optional

The trailing-slash fix is fine. Optional: add “the” for smoother phrasing.

Apply this diff if you agree:

-However, there are some key differences with actual spec; here's [a helpful explainer](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/).
+However, there are some key differences with the actual spec; here's [a helpful explainer](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/).
docs/1.getting-started/09.transitions.md (1)

418-418: Consolidated demo link LGTM

Pointing readers straight to StackBlitz is clearer and reduces link churn.

Optionally consider a read‑only/embedded view for a nicer first‑click experience (StackBlitz supports embed parameters), but fine to keep as-is.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ad97d19 and 752113a.

📒 Files selected for processing (2)
  • docs/1.getting-started/09.transitions.md (1 hunks)
  • docs/2.guide/1.concepts/7.esm.md (1 hunks)

You can check a demo [on StackBlitz](https://stackblitz.com/edit/nuxt-view-transitions).

The Nuxt integration is under active development, but can be enabled with the `experimental.viewTransition` option in your configuration file:
The Nuxt integration can be enabled with the `experimental.viewTransition` option in your configuration file:
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

🧩 Analysis chain

Wording change LGTM; confirm intent to drop “under active development”

Given this is still behind experimental.viewTransition, is it intentional to remove the development-status note for 4.x docs?

If you want, I can run a quick link check over the touched docs to ensure no regressions.


🏁 Script executed:

#!/bin/bash
# Requires Node.js
npx -y markdown-link-check docs/1.getting-started/09.transitions.md -q
npx -y markdown-link-check docs/2.guide/1.concepts/7.esm.md -q

Length of output: 1119


Confirm removal of "under active development" and fix broken docs links

Wording change LGTM; confirm this is intentional while the feature remains behind experimental.viewTransition.

  • Dead links found in docs/1.getting-started/09.transitions.md (7):
    • /docs/4.x/guide/directory-structure/app/pages — 400
    • /docs/4.x/getting-started/transitions#layout-transitions — 400
    • /docs/4.x/guide/directory-structure/app — 400
    • /docs/4.x/api/utils/define-page-meta — 400
    • /docs/4.x/guide/directory-structure/app/layouts — 400
    • https://gsap.com — 403
    • /docs/4.x/guide/directory-structure/app/middleware — 400

Fix or update those links (and replace/remove the gsap link) before merging.

🤖 Prompt for AI Agents
In docs/1.getting-started/09.transitions.md around line 420, confirm that
removing "under active development" is intentional while the feature remains
behind experimental.viewTransition, and fix the seven broken links: replace the
/docs/4.x/... absolute paths with the correct current-docs paths or relative
anchors (or update them to /docs/getting-started/... or the matching v4 routes
used by this repo), correct the transitions anchor to the proper section
(layout-transitions) URL, and update app/pages, app, define-page-meta,
app/layouts, and app/middleware links to their valid doc locations; remove or
replace the https://gsap.com link with an allowed, reachable resource (or a
local note) and verify all updated URLs return 200 before merging.

@danielroe danielroe changed the title docs: fix some links docs: fix more links Sep 18, 2025
@danielroe danielroe merged commit dc69e26 into main Sep 18, 2025
43 of 47 checks passed
@danielroe danielroe deleted the docs/4.x branch September 18, 2025 20:04
@github-actions github-actions bot mentioned this pull request Sep 18, 2025
Copy link

codspeed-hq bot commented Sep 18, 2025

CodSpeed Performance Report

Merging #33265 will not alter performance

Comparing docs/4.x (39751ca) with main (5ada686)1

Summary

✅ 10 untouched

Footnotes

  1. No successful run was found on main (ad97d19) during the generation of this report, so 5ada686 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant