-
-
Couldn't load subscription status.
- Fork 5.4k
docs: fix links #33217
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
docs: fix links #33217
Conversation
|
|
WalkthroughUpdated 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.
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)
✨ Finishing touches
🧪 Generate unit tests
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. Comment |
There was a problem hiding this 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
📒 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-pluginsfragment without redirect.docs/6.bridge/3.bridge-composition-api.md (1)
116-116: Quick sweep complete — only one occurrence found and it's already updatedOnly 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"} |
There was a problem hiding this comment.
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.
| :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.
|
the redirections should be performed client side so if the hash is dropping out there might be a bug |
🔗 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.