Skip to content

docs: add page for vue-i18n components inherited by the module#3986

Open
SAY-5 wants to merge 1 commit into
nuxt-modules:mainfrom
SAY-5:docs/vue-i18n-components
Open

docs: add page for vue-i18n components inherited by the module#3986
SAY-5 wants to merge 1 commit into
nuxt-modules:mainfrom
SAY-5:docs/vue-i18n-components

Conversation

@SAY-5
Copy link
Copy Markdown

@SAY-5 SAY-5 commented May 13, 2026

🔗 Linked issue

resolves #2961

📚 Description

Adds a Vue I18n components page under the Components section, listing the <i18n-t>, <i18n-d> and <i18n-n> components inherited from Vue I18n with links to their upstream API reference. Per @kazupon's note that "it would be good to have a page linking to the documentation on the features provided by vue-i18n".

Summary by CodeRabbit

  • Documentation
    • Added documentation for Vue I18n components available in Nuxt applications, including comprehensive API references and component guidance for internationalization features.

Review Change Stack

@SAY-5 SAY-5 requested a review from BobbieGoede as a code owner May 13, 2026 20:29
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 13, 2026

Walkthrough

A new documentation page introduces Vue I18n components available to Nuxt applications using @nuxtjs/i18n. The page includes front-matter metadata (title and description) and a section listing three components—<i18n-t>, <i18n-d>, and <i18n-n>—with links to their upstream Vue I18n API references and a pointer to the full component API documentation for additional details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately describes the main change: adding a new documentation page for Vue I18n components inherited by the module.
Linked Issues check ✅ Passed The pull request meets the requirement from issue #2961 by adding a dedicated page for Vue I18n components with links to their API references, making them discoverable alongside other component documentation.
Out of Scope Changes check ✅ Passed The pull request contains only the intended documentation addition for Vue I18n components with no out-of-scope changes or unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

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

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.

🧹 Nitpick comments (1)
docs/content/docs/05.components/03.vue-i18n-components.md (1)

1-14: The documentation structure uses numbered files (01, 02, 03) within the Components section, which means all pages—including this Vue I18n components page—will be automatically discoverable in the navigation sidebar. However, consider adding a brief cross-reference or "See also" note in the module's component documentation (files 01 and 02) to make users aware that Vue I18n provides additional built-in components available in their application. This would improve the narrative flow between the module's custom components and Vue I18n's built-in ones.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/content/docs/05.components/03.vue-i18n-components.md` around lines 1 -
14, Add a concise "See also" cross-reference in the Components docs pages (the
numbered component docs files "01" and "02") linking to this Vue I18n components
page so readers know Vue I18n provides additional built-in components; update
the component docs' closing section (e.g., after the description or examples in
files 01 and 02) to include a short note like "See also: Vue I18n components"
with a link to docs/05.components/03.vue-i18n-components.md and ensure the link
text and placement mirror existing navigation style for consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/content/docs/05.components/03.vue-i18n-components.md`:
- Around line 1-14: Add a concise "See also" cross-reference in the Components
docs pages (the numbered component docs files "01" and "02") linking to this Vue
I18n components page so readers know Vue I18n provides additional built-in
components; update the component docs' closing section (e.g., after the
description or examples in files 01 and 02) to include a short note like "See
also: Vue I18n components" with a link to
docs/05.components/03.vue-i18n-components.md and ensure the link text and
placement mirror existing navigation style for consistency.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: bd5a0a4d-5768-4d0e-bc99-7eb6c6576829

📥 Commits

Reviewing files that changed from the base of the PR and between b12514f and 49690dd.

📒 Files selected for processing (1)
  • docs/content/docs/05.components/03.vue-i18n-components.md

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.

docs: Add note/link about i18n-t,… on components api page

1 participant