Skip to content

Conversation

@huang-julien
Copy link
Member

@huang-julien huang-julien commented Sep 12, 2025

🔗 Linked issue

fix #33216

📚 Description

A small PR to temporarly fix a few links. There's a bigger issue in our documentations. redirections removes hashes anchor from the URL since it is not sent by the browser.

@bolt-new-by-stackblitz
Copy link

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

@coderabbitai
Copy link

coderabbitai bot commented Sep 12, 2025

Walkthrough

Updated ReadMore links in two documentation pages to point from /docs/guide/directory-structure/plugins#creating-plugins to /docs/guide/directory-structure/app/plugins#creating-plugins. Files affected: docs/3.api/3.utils/define-nuxt-plugin.md and docs/6.bridge/3.bridge-composition-api.md. No other content or structural changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Pre-merge checks (5 passed)

✅ Passed checks (5 passed)
Check name Status Explanation
Title Check ✅ Passed The title "docs: fix links" is concise, follows conventional-commit style, and accurately summarises the PR's primary change of updating documentation links as shown in the raw_summary; it is clear and relevant for a reviewer scanning history.
Linked Issues Check ✅ Passed The PR implements the change requested in the linked issue [#33216] by updating the ReadMore link in docs/6.bridge/3.bridge-composition-api.md to the specified /docs/guide/directory-structure/app/plugins#creating-plugins and also applies a consistent link update in docs/3.api/3.utils/define-nuxt-plugin.md, matching the PR objective of temporarily fixing a few documentation links; the raw_summary shows no code or public API changes to validate.
Out of Scope Changes Check ✅ Passed All changes are limited to documentation markdown files and are link edits that align with the linked issue and PR objectives; the raw_summary shows no unrelated code, tests, or public API modifications, so no out-of-scope changes are detected.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The pull request description references linked issue #33216 and explains the intent to temporarily fix documentation links because redirections strip URL fragments. That intent aligns with the changes shown in the diff which update read-more links in documentation files. Therefore the description is directly related to the changeset and provides adequate context for reviewers.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/link

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0dcc386 and a58c776.

📒 Files selected for processing (2)
  • docs/3.api/3.utils/define-nuxt-plugin.md (1 hunks)
  • docs/6.bridge/3.bridge-composition-api.md (1 hunks)
🔇 Additional comments (2)
docs/3.api/3.utils/define-nuxt-plugin.md (1)

19-19: LGTM: correct component and prop

:read-more{to=...} matches current docs conventions and should preserve the #creating-plugins fragment without redirect.

docs/6.bridge/3.bridge-composition-api.md (1)

116-116: Quick sweep complete — only one occurrence found and it's already updated

Only match: docs/6.bridge/3.bridge-composition-api.md:116 — :ReadMore{link="/docs/guide/directory-structure/app/plugins#creating-plugins"}.

::

:ReadMore{link="/docs/guide/directory-structure/plugins#creating-plugins"}
:ReadMore{link="/docs/guide/directory-structure/app/plugins#creating-plugins"}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Use the lowercase component and to prop (align with issue #33216)

This still uses :ReadMore{link=...}. The linked issue requests :read-more{to=...}. Update to avoid redirects and ensure consistency.

Apply:

-:ReadMore{link="/docs/guide/directory-structure/app/plugins#creating-plugins"}
+:read-more{to="/docs/guide/directory-structure/app/plugins#creating-plugins"}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
:ReadMore{link="/docs/guide/directory-structure/app/plugins#creating-plugins"}
:read-more{to="/docs/guide/directory-structure/app/plugins#creating-plugins"}
🤖 Prompt for AI Agents
In docs/6.bridge/3.bridge-composition-api.md around line 116, the shortcode uses
the incorrect casing and prop
(:ReadMore{link="/docs/guide/directory-structure/app/plugins#creating-plugins"});
change it to the lowercase shortcode and prop format
(:read-more{to="/docs/guide/directory-structure/app/plugins#creating-plugins"})
so it matches issue #33216, avoids redirects, and maintains consistency across
docs.

@danielroe
Copy link
Member

the redirections should be performed client side so if the hash is dropping out there might be a bug

@danielroe danielroe merged commit 80cc245 into main Sep 12, 2025
9 of 10 checks passed
@danielroe danielroe deleted the docs/link branch September 12, 2025 21:10
@github-actions github-actions bot mentioned this pull request Sep 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix link in /docs

2 participants