docs: improve `@nuxt/kit` documentation #31793

Mini-ghost · 2025-04-14T17:02:55Z

🔗 Linked issue

📚 Description

This PR refines the documentation for @nuxt/kit with the following improvements:

Usage:
Adds a minimal usage example to help users quickly understand how to use the function.
Type (or Type Signature):
Replaces detailed type definitions with simplified syntax signatures. As mentioned in Standardizing section order in Nuxt documentation for better readability #30930 (comment), this helps prevent the documentation from becoming outdated as types evolve across versions.
Parameters:
Reformats the "Parameters" section using tables for improved readability. The new format will look like this:
Examples:
Adds more usage scenarios to demonstrate how these functions behave in context and how their parameters can be applied in different situations.

If there's anything incorrect or if you have any suggestions, please feel free to let me know. Thank you!

bolt-new-by-stackblitz · 2025-04-14T17:02:58Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-04-25T15:49:38Z

Walkthrough

The documentation for various Nuxt Kit APIs has undergone extensive restructuring and clarification across multiple areas. For module utilities, verbose TypeScript interface declarations have been replaced with concise usage examples, markdown tables summarising parameters, and new sections on module compatibility and programmatic installation. Template utilities documentation now features practical examples, property tables, and introduces the addServerTemplate function, while clarifying options and usage for all template functions. Nitro server utilities documentation has been overhauled with usage-first examples, property tables, and clearer explanations for handlers, plugins, and directory scanning functions. Path resolving utilities now present usage examples before type details, expand on available options, and standardise formatting. Builder utilities documentation has been reordered to prioritise Vite, with updated examples, option tables, and corrected descriptions. Programmatic Nuxt Kit usage documentation has simplified type signatures and parameter descriptions, removing redundant interface declarations. Compatibility utilities now include improved examples, updated type signatures, and clearer deprecation notes. Minor changes include renaming table columns for clarity in auto-import and component utilities, and significant improvements in layout, plugin, and context utility documentation, all focusing on clarity, practical examples, and consistency. No changes were made to the actual code or exported API signatures; all modifications are confined to documentation content and structure.

📜 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 dc7e3eb and 7e11e7a.

📒 Files selected for processing (1)

docs/3.api/5.kit/5.components.md (4 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/3.api/5.kit/5.components.md

[misspelling] ~131-~131: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ou want to auto-import a component from an npm package, and the component is a nam...

(EN_A_VS_AN)

🔇 Additional comments (5)

docs/3.api/5.kit/5.components.md (5)

49-49: Improved clarity: “Property” header
Replacing the terse “Prop” header with “Property” makes the parameters table clearer and more consistent with other API docs.

69-69: Consistent table header in opts section
Updating the column header to “Property” aligns this table with the rest of the documentation and enhances readability.

113-113: Unified terminology for addComponent parameters
Changing “Prop” to “Property” maintains consistency across all parameter tables in the Kit docs.

128-128: Documented new priority option
Great addition of the priority field—please verify that AddComponentOptions (in the TypeScript definitions) includes a priority?: number property to match this documentation.

129-146: Excellent usage example for named exports
The new “Examples” section demonstrates how to auto-import a named export from an npm package very clearly. This will help users understand the export option in context.

🧰 Tools

🪛 LanguageTool

[misspelling] ~131-~131: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ou want to auto-import a component from an npm package, and the component is a nam...

(EN_A_VS_AN)

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (11)

docs/3.api/5.kit/7.pages.md (1)

112-113: Improve parameter descriptions and markdown formatting

The route and rule descriptions are clear; however, consider replacing the trailing backslash (\) used for the line break with two spaces at the end of the line to follow standard Markdown conventions.

docs/3.api/5.kit/12.resolving.md (2)

67-77: Clarify Default Options in the Example
The added defaults: { prefix: 'Headless' } configuration object in the example is never referenced or used later in the snippet. Consider either demonstrating how prefix influences component names or removing it to avoid confusion.

91-96: Document Additional addComponent Options
The example now passes mode: 'all' to addComponent, but there is no explanation or link to the addComponent API that defines mode. It would be helpful to add a brief note or a link to the addComponent documentation to explain available modes and their effects.

docs/3.api/5.kit/14.builder.md (2)

3-3: Refine Documentation Description Grammar
Change the description from Nuxt Kit provides a set of utilities to help you work with the builder. to Nuxt Kit provides a set of utilities to help you work with builder configurations. for clarity.

11-11: Grammar Fix: Subject-Verb Agreement
Replace Nuxt have builders based on... with Nuxt has builders based on... or Nuxt provides builders based on... to correct the verb agreement.

docs/3.api/5.kit/11.nitro.md (3)

15-17: addServerHandler documentation is clear and well-structured.
The new description, usage example, parameter table, and code snippets provide a concise yet comprehensive overview of how to add Nitro handlers. Consider refining minor grammar in the parameters table for consistency, e.g., “Path to event handler” → “Path to the event handler” and “If an empty string used” → “If an empty string is used”.

Also applies to: 19-32, 42-50, 52-56, 60-67, 75-85

92-99: addDevServerHandler section looks good and informative.
The usage example and parameter definitions clearly differentiate dev-only handlers. You may want to standardise phrasing: change “Excluded from production build” → “Excluded from the production build” for consistency.

Also applies to: 105-111, 124-130

197-204: addServerPlugin documentation improvements.
The usage snippet and parameter table are well presented. One nit: ensure consistency in describing the plugin path, e.g., “Path to the plugin.” → “Path to the plugin file.”

Also applies to: 218-221

docs/3.api/5.kit/9.plugins.md (1)

11-12: addPlugin section is well reorganised with clear usage and parameter tables.
The revised examples and structured tables significantly improve readability. As a small refinement, consider specifying “the plugin file” consistently in the src description and adding “the” in phrases like “plugin array” → “the plugins array” for consistency.

Also applies to: 15-16, 21-36, 39-42, 44-54, 56-58, 68-95

docs/3.api/5.kit/2.programmatic.md (1)

20-23: loadNuxt signature and parameter description are concise.
The switch to a simple function returning a promise is clear. Consider refining the description at line 15 from “instantiate and return the promise with Nuxt instance” to better reflect returning a promise that resolves to the Nuxt instance.

Also applies to: 25-31

docs/3.api/5.kit/3.compatibility.md (1)

17-24: checkNuxtCompatibility section is concise and informative.
The usage example, type signature, and constraints table clearly explain how to validate versions. Consider adding “the” in descriptions for uniformity, e.g., “If not provided, it will be retrieved from the context via useNuxt() call” → “If not provided, it will be retrieved from the context via the useNuxt() call.”

Also applies to: 37-38, 42-48

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a688c9d and dc7e3eb.

📒 Files selected for processing (15)

docs/3.api/5.kit/1.modules.md (2 hunks)
docs/3.api/5.kit/10.runtime-config.md (1 hunks)
docs/3.api/5.kit/10.templates.md (2 hunks)
docs/3.api/5.kit/11.nitro.md (11 hunks)
docs/3.api/5.kit/12.resolving.md (7 hunks)
docs/3.api/5.kit/13.logging.md (2 hunks)
docs/3.api/5.kit/14.builder.md (2 hunks)
docs/3.api/5.kit/2.programmatic.md (4 hunks)
docs/3.api/5.kit/3.compatibility.md (3 hunks)
docs/3.api/5.kit/4.autoimports.md (3 hunks)
docs/3.api/5.kit/5.components.md (3 hunks)
docs/3.api/5.kit/6.context.md (3 hunks)
docs/3.api/5.kit/7.pages.md (2 hunks)
docs/3.api/5.kit/8.layout.md (1 hunks)
docs/3.api/5.kit/9.plugins.md (3 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/3.api/5.kit/13.logging.md

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...aInstance ``` ### Parameters tag: A tag to suffix all log messages with. ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...ix all log messages with. options: Consola configuration options. ### Exa...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/1.modules.md

[style] ~156-~156: To form a complete sentence, be sure to include a subject.
Context: ... | true | The module to install. Can be either a string with the module name...

(MISSING_IT_THERE)

docs/3.api/5.kit/7.pages.md

[style] ~54-~54: To form a complete sentence, be sure to include a subject.
Context: ...alse` | Custom metadata for the route. Can be used in layouts, middlewares, or nav...

(MISSING_IT_THERE)

[uncategorized] ~62-~62: Loose punctuation mark.
Context: ...patterns with specific route settings. ::tip You can read more about Nitro route...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~64-~64: Loose punctuation mark.
Context: ...tro.unjs.io/guide/routing#route-rules). :: ::tip{icon="i-lucide-video" to="https...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...unjs.io/guide/routing#route-rules). :: ::tip{icon="i-lucide-video" to="https://v...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ding route rules and route middelwares. :: ### Usage ```ts twoslash import { cr...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...uration to apply to the matched route. ::tip About route rules configurations, y...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~116-~116: Loose punctuation mark.
Context: .../guide/concepts/rendering#route-rules). :: options: A object to pass to the ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~129-~129: A different word order might sound more natural.
Context: ...specific routes. Route middlewares can be also defined in plugins via [`addRouteMiddle...

(AI_HYDRA_LEO_WORD_ORDER)

[uncategorized] ~130-~130: Loose punctuation mark.
Context: ...tils/add-route-middleware) composable. ::tip Read more about route middlewares i...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~132-~132: Loose punctuation mark.
Context: ...ting-started/routing#route-middleware). :: ::tip{icon="i-lucide-video" to="https...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~134-~134: Loose punctuation mark.
Context: ...-started/routing#route-middleware). :: ::tip{icon="i-lucide-video" to="https://v...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...ding route rules and route middelwares. :: ### Usage ::code-group ```ts twosla...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...s and route middelwares. :: ### Usage ::code-group ```ts twoslash [module.ts] ...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/8.layout.md

[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...: void ``` ### Parameters layout: A template object or a string with the ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~57-~57: Loose punctuation mark.
Context: ... | name: The name to register the layout under (...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...

About Page

``` ::warning Due to the lack of support for ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...to the first argument ofaddLayout`. ::

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/14.builder.md

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...s?: ExtendViteConfigOptions): void ``` ::read-more{to="https://vite.dev/config" ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...re information about its configuration. :: ### Parameters callback: A cal...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...tion. :: ### Parameters callback: A callback function that will be called...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ite configuration object. options: Options to pass to the callback functio...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~83-~83: Loose punctuation mark.
Context: ... ExtendWebpackConfigOptions): void ``` ::read-more{to="https://webpack.js.org/co...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~85-~85: Loose punctuation mark.
Context: ...re information about its configuration. :: ### Parameters callback: A cal...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~90-~90: Loose punctuation mark.
Context: ...tion. :: ### Parameters callback: A callback function that will be called...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...ack configuration object. options: Options to pass to the callback functio...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~133-~133: Loose punctuation mark.
Context: ...s?: ExtendViteConfigOptions): void ``` ::tip See [Vite website](https://vite.dev...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~135-~135: Loose punctuation mark.
Context: ...to find a plugin that suits your needs. :: ### Parameters pluginOrGetter:...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...:: ### Parameters pluginOrGetter: A Vite plugin instance or an array of V...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~142-~142: Loose punctuation mark.
Context: ...of Vite plugin instances. options: Options to pass to the callback functio...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~188-~188: Loose punctuation mark.
Context: ... ExtendWebpackConfigOptions): void ``` ::tip See [webpack website](https://webpa...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~190-~190: Loose punctuation mark.
Context: ...to find a plugin that suits your needs. :: ### Parameters pluginOrGetter:...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~195-~195: Loose punctuation mark.
Context: ...:: ### Parameters pluginOrGetter: A webpack plugin instance or an array o...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~197-~197: Loose punctuation mark.
Context: ...webpack plugin instances. options: Options to pass to the callback functio...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~219-~219: Loose punctuation mark.
Context: ...``` ### Parameters pluginFactory: A factory function that returns an obje...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~219-~219: Possible missing comma found.
Context: ...gin instance or an array of Vite plugin instances and/or a webpack plugin instance or an ...

(AI_HYDRA_LEO_MISSING_COMMA)

[uncategorized] ~221-~221: Loose punctuation mark.
Context: ...webpack plugin instances. options: Options to pass to the callback functio...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/9.plugins.md

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...ugin and adds it to the plugins array. ::tip{icon="i-lucide-video" to="https://v...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...tch Vue School video about addPlugin. :: ### Usage ```ts twoslash import { ad...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...Plugin ``` ### Parameters plugin: A plugin object or a string with the pa...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~53-~53: You might be missing the article “the” here.
Context: ...and .server modifiers when specifying src option to use plugin only in client...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~53-~53: You might be missing the article “the” here.
Context: ...ers when specifying src option to use plugin only in client or server side. | | `ord...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~53-~53: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...cifying src option to use plugin only in client or server side. | | order | `...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)

[uncategorized] ~53-~53: You might be missing the article “the” here.
Context: ...ying src option to use plugin only in client or server side. | | order | number...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~55-~55: Loose punctuation mark.
Context: ...s that run after Nuxt plugins). | ::warning Avoid using order unless nece...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...o register plugins after Nuxt defaults. :: options: Optional object with t...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...s after Nuxt defaults. :: options: Optional object with the following prop...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~67-~67: Loose punctuation mark.
Context: .... Defaults to false. | ### Examples ::code-group ```ts [module.ts] import { ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...School video about addPluginTemplate. :: ### Usage ```ts twoslash import { ad...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...``` ### Parameters pluginOptions: A plugin template object with the follo...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~143-~143: You might be missing the article “the” here.
Context: ...and .server modifiers when specifying src option to use plugin only in client...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~143-~143: You might be missing the article “the” here.
Context: ...ers when specifying src option to use plugin only in client or server side. | | `opt...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~143-~143: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...cifying src option to use plugin only in client or server side. | | options ...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)

[uncategorized] ~143-~143: You might be missing the article “the” here.
Context: ...ying src option to use plugin only in client or server side. | | options | `Re...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~148-~148: Loose punctuation mark.
Context: ...s that run after Nuxt plugins). | ::warning Prefer using getContents for ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...Avoid setting order unless necessary. :: options: Optional object with t...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...der unless necessary. :: **options`**: Optional object with the following prop...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~192-~192: Loose punctuation mark.
Context: ...pending on the provided configuration. ::code-group ```ts [nuxt.config.ts] expo...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~215-~215: Loose punctuation mark.
Context: ...config["idPrefix"] = "nuxt" } }) ``` :: #### Using an EJS template to generat...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~221-~221: Loose punctuation mark.
Context: ...mplate to generate the plugin content. ::code-group ```ts [module.ts] import { ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~261-~261: Loose punctuation mark.
Context: ... firebaseApp) } <% } %> }) ``` :: ::warning If you set `compatibilityVersio...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~263-~263: Loose punctuation mark.
Context: ...ved entirely in the next major version. ::

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/12.resolving.md

[uncategorized] ~38-~38: Loose punctuation mark.
Context: ... ``` ### Parameters path: A path to resolve. `options`: Opti...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~40-~40: Loose punctuation mark.
Context: ...th**: A path to resolve. **options`**: Options to pass to the resolver. This o...

(UNLIKELY_OPENING_PUNCTUATION)

[grammar] ~48-~48: The word “fallback” is a noun. The verb is spelled with a white space.
Context: ... | false | Whether to fallback to the original path if the resolved pa...

(NOUN_VERB_CONFUSION)

[uncategorized] ~112-~112: Loose punctuation mark.
Context: ...: string ``` ### Parameters path: A path to resolve. `alias`: An obj...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~114-~114: Loose punctuation mark.
Context: ...path**: A path to resolve. **alias`**: An object of aliases. If not provided, ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...| null> ``` ### Parameters paths: A path or an array of paths to resolve....

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~147-~147: Loose punctuation mark.
Context: ...rray of paths to resolve. options: Options to pass to the resolver. This o...

(UNLIKELY_OPENING_PUNCTUATION)

[grammar] ~155-~155: The word “fallback” is a noun. The verb is spelled with a white space.
Context: ... | false | Whether to fallback to the original path if the resolved pa...

(NOUN_VERB_CONFUSION)

[uncategorized] ~185-~185: Loose punctuation mark.
Context: ...lver ``` ### Parameters basePath: A base path to resolve from. It can be ...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/11.nitro.md

[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ... | false | Router method matcher. If handler name contains method name, it will be u...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~50-~50: You might be missing the article “a” here.
Context: ...ethod matcher. If handler name contains method name, it will be used as a default valu...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...add a server handler from your module. ::code-group ```ts twoslash [module.ts] ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~330-~330: Loose punctuation mark.
Context: ...ctions from a custom server directory. ::code-group ```ts twoslash [module.ts] ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~354-~354: Loose punctuation mark.
Context: ...ntimeConfig() return apiSecret } ``` :: You can then use the useApiSecret f...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~370-370: Loose punctuation mark.
Context: ...ed just like the ~/server folder is. ::note Only ~/server/api, `/server/rou...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~372-372: Loose punctuation mark.
Context: ...are, and /server/utils` are scanned. :: ### Usage ```ts twoslash import { de...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~408-~408: Loose punctuation mark.
Context: ...want to add a custom server directory. ::code-group ```ts twoslash [module.ts] ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~430-~430: Loose punctuation mark.
Context: ...return 'Hello from server utils!' } ``` :: You can then use the hello function...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/6.context.md

[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...hout having to pass it as an argument. ::note When you're working with the `setu...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...ly without needing to call useNuxt(). :: ## useNuxt Get the Nuxt instance f...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... | ### Examples ::code-group ```ts twoslash [setupTransp...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~115-~115: Loose punctuation mark.
Context: ...n the useNuxt section. ### Examples ::code-group ```ts twoslash [requireSite...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/2.programmatic.md

[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...> ``` ### Parameters loadOptions: Loading conditions for Nuxt. `loadNuxt`...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...ise ``` ### Parameters nuxt: Nuxt instance to build. It can be retri...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...ions> ``` ### Parameters options: Options to pass in [`c12`](https://gith...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...t): void ``` ### Parameters nuxt: Nuxt instance to build. It can be retri...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/10.templates.md

[style] ~82-~82: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...a virtual file named meta.config.mjs. In the runtime plugin, we can import it us...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

docs/3.api/5.kit/3.compatibility.md

[uncategorized] ~42-~42: Loose punctuation mark.
Context: ...; ``` ### Parameters constraints: Version and builder constraints to chec...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~49-~49: Loose punctuation mark.
Context: .... Use false to disable. | nuxt: Nuxt instance. If not provided, it will...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~63-~63: Loose punctuation mark.
Context: ...; ``` ### Parameters constraints: Version and builder constraints to chec...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...](#parameters) for details. **nuxt`**: Nuxt instance. If not provided, it will...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~96-~96: Loose punctuation mark.
Context: ...; ``` ### Parameters constraints: Version and builder constraints to chec...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...](#parameters) for details. **nuxt`**: Nuxt instance. If not provided, it will...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...all. ## isNuxtMajorVersion Check if current Nuxt instance is of specified major ver...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...` Check if current Nuxt instance is of specified major version ### Usage ```ts twoslas...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~127-~127: Loose punctuation mark.
Context: ...oolean; ``` ### Parameters major: Major version to check against. **`nux...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~129-~129: Loose punctuation mark.
Context: ...or version to check against. nuxt: Nuxt instance. If not provided, it will...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~134-~134: Loose punctuation mark.
Context: ...ks if the current Nuxt version is 3.x. ::note Use isNuxtMajorVersion(2, nuxt) ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...@nuxt/kit v5 or a future major version. :: ### Type ```ts function isNuxt3(nuxt...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~147-~147: Loose punctuation mark.
Context: ...boolean; ``` ### Parameters nuxt: Nuxt instance. If not provided, it will...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~152-~152: Loose punctuation mark.
Context: ...ks if the current Nuxt version is 2.x. ::note Use isNuxtMajorVersion(2, nuxt) ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~154-~154: Loose punctuation mark.
Context: ...@nuxt/kit v5 or a future major version. :: ### Type ```ts function isNuxt2(nuxt...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~165-~165: Loose punctuation mark.
Context: ...boolean; ``` ### Parameters nuxt: Nuxt instance. If not provided, it will...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~179-~179: Loose punctuation mark.
Context: ... string; ``` ### Parameters nuxt: Nuxt instance. If not provided, it will...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (53)

docs/3.api/5.kit/4.autoimports.md (1)

61-61: Standardise table column header

Renamed the parameter table header from “Prop” to “Property” across addImports, addImportsDir and addImportsSources for improved clarity and consistency with other Nuxt Kit docs.

Also applies to: 101-101, 141-141

docs/3.api/5.kit/5.components.md (1)

49-49: Consistent parameter table header rename

The column header has been updated from “Prop” to “Property” in both the addComponentsDir and addComponent parameter tables, aligning with the overall documentation style.

Also applies to: 69-69, 113-113
docs/3.api/5.kit/10.runtime-config.md (1)

25-29: Add explicit Type signature

The new “Type” subsection clearly shows:
function updateRuntimeConfig (config: Record<string, unknown>): void | Promise<void>
This aligns with other API sections and enhances clarity.
docs/3.api/5.kit/13.logging.md (1)

17-29: Add useLogger Usage example

The newly introduced “Usage” section with a minimal ts twoslash code block demonstrates how to import and invoke useLogger, improving hands-on guidance.
docs/3.api/5.kit/7.pages.md (12)

19-37: Add extendPages Usage example

The new ts twoslash example for extendPages clearly illustrates how to register and modify routes within a Nuxt module.

42-43: Document extendPages Type signature

Including the explicit signature
function extendPages(callback: (pages: NuxtPage[]) => void): void
aligns with the rest of the Kit docs and aids discoverability.

47-48: Clarify callback parameter

The description concisely explains how to mutate the provided pages array in-place, which is accurate and helpful.

49-57: Create NuxtPage property table

The property table for NuxtPage (name, path, file, meta, alias, redirect, children) is well-structured and enhances readability.

🧰 Tools

🪛 LanguageTool

[style] ~54-~54: To form a complete sentence, be sure to include a subject.
Context: ...alse` | Custom metadata for the route. Can be used in layouts, middlewares, or nav...

(MISSING_IT_THERE)

71-102: Add extendRouteRules Usage example

The new snippet demonstrates both redirect and cache rules in context, giving users a quickstart on route-level configuration.

107-108: Document extendRouteRules Type signature

Explicitly showing
function extendRouteRules(route: string, rule: NitroRouteConfig, options?: ExtendRouteRulesOptions): void
maintains consistency across the API docs.

119-119: Clarify options parameter

The concise description of the options object and its override flag is accurate and easy to understand.

121-123: Create ExtendRouteRulesOptions table

The table neatly summarises the override property and its default, improving quick reference.

139-157: Add addRouteMiddleware Usage example

The code-group containing both the module definition and the runtime middleware file gives a comprehensive view of how to register and implement custom route middleware.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...s and route middelwares. :: ### Usage ::code-group ```ts twoslash [module.ts] ...

(UNLIKELY_OPENING_PUNCTUATION)

172-174: Document addRouteMiddleware Type signature

Showing
function addRouteMiddleware(input: NuxtMiddleware | NuxtMiddleware[], options?: AddRouteMiddlewareOptions): void
is consistent with the documentation style and clarifies expected inputs.

178-184: Define input parameter and table

The table under input clearly outlines required middleware properties (name, path, global), which is helpful for end-users.

186-192: Define options parameter and table

The table summarising the override and prepend options with their defaults is concise and informative.
docs/3.api/5.kit/8.layout.md (1)

21-36: Usage Example Is Clear and Well-Structured
The new Usage section preceding the type signature provides a concise, copy-and-pasteable example that clearly demonstrates how to call addLayout within a Nuxt module. The imports and createResolver usage are correct and align with the surrounding documentation style.

docs/3.api/5.kit/12.resolving.md (1)

17-28: Approve: First-Class Usage Example
The Usage block for resolvePath now appears before the type and parameter tables, improving discoverability. The asynchronous example inside defineNuxtModule correctly shows await resolvePath with logging, which aligns with the PR’s pattern of usage-first documentation.

docs/3.api/5.kit/14.builder.md (4)

17-30: Approve: extendViteConfig Usage
The extendViteConfig usage snippet clearly demonstrates how to manipulate optimizeDeps using the logical OR assignment operator (||=). Its placement before the type section follows the PR’s usage-first pattern.

67-74: Approve: extendWebpackConfig Usage
The extendWebpackConfig example is concise and shows how to push a new rule for .txt files. The indentation and code fence style remain consistent with the rest of the docs.

109-124: Approve: addVitePlugin Usage
This snippet clearly illustrates adding a Vite plugin using addVitePlugin, and it remains consistent with the patterns for options and imports shown elsewhere.

160-179: Approve: addWebpackPlugin Usage
The webpack plugin example using EslintWebpackPlugin is well-formatted and correctly shows how to pass custom options and disable server linting.

docs/3.api/5.kit/1.modules.md (7)

17-36: Approve: defineNuxtModule Usage Example
The new Usage section demonstrates a minimal module definition with meta, defaults, and setup, matching the PR’s goal of concise, example-driven docs.

38-41: Approve: Type Signature Clarity
The type signature function defineNuxtModule (definition: ModuleDefinition | NuxtModule): NuxtModule is concise and correctly presented.

44-46: Approve: Parameters Table Introduction
Replacing the verbose interface declaration with a concise parameters table improves readability and maintenance.

71-74: Approve: configKey Example
The snippet showing how to use configKey in nuxt.config is helpful, with clear property names and indentation.

85-89: Approve: nuxt.config Configuration Snippet
Displaying how users can disable the module via nuxt.config under the myModule key aligns well with the documented configKey feature.

97-103: Approve: Compatibility Example
The compatibility example with compatibility.nuxt is clear; the semver snippet and warning message make it easy to understand version constraints.

126-129: Approve: installModule Example
This usage example demonstrates programmatic module installation with inline options, fulfilling the PR objective of richer usage scenarios.

docs/3.api/5.kit/6.context.md (9)

11-14: Approve: Introductory Paragraph Revision
The revised introduction succinctly highlights useNuxt and tryUseNuxt utilities, improving clarity over the previous verbose description.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...hout having to pass it as an argument. ::note When you're working with the `setu...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...ly without needing to call useNuxt(). :: ## useNuxt Get the Nuxt instance f...

(UNLIKELY_OPENING_PUNCTUATION)

21-27: Approve: useNuxt Usage Example
The new minimal usage snippet makes it easy to understand how to import and call useNuxt() in any context.

35-37: Approve: useNuxt Type Signature
The type block is concise and correctly shows function useNuxt(): Nuxt.

42-42: Approve: Return Value Description
The added description of the returned Nuxt instance properties clarifies the API without overwhelming readers.

56-67: Approve: setupTranspilation Example
The grouped setupTranspilation example effectively demonstrates conditional usage of nuxt.options and logical OR assignment.

85-96: Approve: tryUseNuxt Usage Example
The snippet clearly contrasts handling when Nuxt is unavailable, showcasing fallback logic.

104-105: Approve: tryUseNuxt Type Signature
The function signature block is presented consistently and correctly shows the return type Nuxt | null.

110-112: Approve: tryUseNuxt Return Value Description
The clarification that tryUseNuxt returns null when Nuxt is not available aligns with developer expectations.

118-142: Approve: requireSiteConfig Examples
The combined examples for requireSiteConfig and how to consume its output in a module demonstrate real-world use cases and correctly reflect the updated nullable title property.

docs/3.api/5.kit/11.nitro.md (4)

166-172: useNitro usage example is concise and accurate.
Great addition of a clear usage snippet. Approving.

Also applies to: 175-178

255-259: addPrerenderRoutes examples and type signature align well.
The usage scenario is clear. Approving changes.

Also applies to: 262-265

295-300: addServerImportsDir usage and parameter table are well formatted.
The examples and table improve clarity. No changes needed.

Also applies to: 320-324

330-332: addServerScanDir note and usage snippet are helpful.
The note clearly outlines default scan directories. Example usage is concise. Approving.

Also applies to: 334-338

🧰 Tools

🪛 LanguageTool

[uncategorized] ~330-~330: Loose punctuation mark.
Context: ...ctions from a custom server directory. ::code-group ```ts twoslash [module.ts] ...

(UNLIKELY_OPENING_PUNCTUATION)

docs/3.api/5.kit/9.plugins.md (1)

107-126: addPluginTemplate section offers comprehensive examples and tables.
The dynamic generation and EJS template samples are valuable. For consistency, you might rephrase the warning at line 263 from “If you set compatibilityVersion to 4” to “When compatibilityVersion is set to 4, …”. Otherwise, this is an excellent enhancement.

Also applies to: 128-132, 136-148, 149-158, 165-189, 194-214, 218-236, 262-264

docs/3.api/5.kit/2.programmatic.md (2)

39-42: buildNuxt documentation is accurate and clear.
The type signature and parameter description clearly convey usage. No changes needed.

Also applies to: 44-46

53-54: loadNuxtConfig signature and parameters look correct.
The concise table for options improves readability. Approving.

Also applies to: 58-60

docs/3.api/5.kit/10.templates.md (4)

15-17: addTemplate section is clearer and more developer-friendly.
The new description, usage example, type signature, and concise parameter table effectively replace the verbose interface. Excellent work.

Also applies to: 19-22, 30-33, 41-42, 44-55, 63-67

104-113: addTypeTemplate section improvements are excellent.
The added usage example and context parameter explanation enrich the documentation. Everything is spot on.

Also applies to: 124-127, 131-138, 150-158

192-197: addServerTemplate documentation is comprehensive.
The new section with clear usage, type signature, and parameter details is highly beneficial. Approving.

Also applies to: 199-208, 213-217, 223-227, 230-237

263-272: updateTemplates section is well-structured and clear.
The usage scenario, type signature, and parameter table cover all necessary details. No further changes needed.

Also applies to: 285-289, 293-297

docs/3.api/5.kit/3.compatibility.md (4)

57-59: assertNuxtCompatibility signature and behaviour are well-documented.
The promise return value and error semantics are clear. Approving.

71-75: hasNuxtCompatibility usage and signature are correct.
The example helps illustrate real use. No changes needed.

Also applies to: 91-92

101-104: isNuxtMajorVersion documentation is clear and precise.
The description and signature are accurately presented. Approving.

Also applies to: 121-122

🧰 Tools

🪛 LanguageTool

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...all. ## isNuxtMajorVersion Check if current Nuxt instance is of specified major ver...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...` Check if current Nuxt instance is of specified major version ### Usage ```ts twoslas...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

133-137: Deprecation notes for isNuxt3 and isNuxt2 are appropriate.
The guidance to prefer isNuxtMajorVersion is helpful. Approving.

Also applies to: 149-153

🧰 Tools

🪛 LanguageTool

[uncategorized] ~134-~134: Loose punctuation mark.
Context: ...ks if the current Nuxt version is 3.x. ::note Use isNuxtMajorVersion(2, nuxt) ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~136-~136: Loose punctuation mark.
Context: ...@nuxt/kit v5 or a future major version. :: ### Type ```ts function isNuxt3(nuxt...

(UNLIKELY_OPENING_PUNCTUATION)

coderabbitai · 2025-04-25T15:49:41Z

docs/3.api/5.kit/13.logging.md

+**`tag`**: A tag to suffix all log messages with.

-**Type**: `Partial<ConsolaOptions>`
-
-**Optional**: `true`
-
-Consola configuration options
+**`options`**: Consola configuration options.


💡 Verification agent

🧩 Analysis chain

Parameter description for tag seems inverted

The documentation states that tag will suffix log messages, but in practice it prepends (prefixes) the tag to log entries. Please verify the intended behaviour and correct the description.

🏁 Script executed:

#!/bin/bash # Search for usage of `withTag` or tag handling in the Kit logging implementation rg -n "withTag" -A5 -B5 . rg -n "tag" -A5 -B5 packages/kit

Length of output: 5612

Update tag description from “suffix” to “prefix”

The useLogger(tag, options) implementation calls consola.create(options).withTag(tag), which prefixes the tag to each message (it doesn’t suffix). Please adjust the docs accordingly:

• File: docs/3.api/5.kit/13.logging.md
Lines: 39–41

- **`tag`**: A tag to suffix all log messages with. + **`tag`**: A tag to prefix all log messages with. **`options`**: Consola configuration options.

📝 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

**`tag`**: A tag to suffix all log messages with.

**Type**: `Partial<ConsolaOptions>`

**Optional**: `true`

Consola configuration options

**`options`**: Consola configuration options.

**`tag`**: A tag to prefix all log messages with.

**`options`**: Consola configuration options.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~39-~39: Loose punctuation mark.
Context: ...aInstance ``` ### Parameters tag: A tag to suffix all log messages with. ...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...ix all log messages with. options: Consola configuration options. ### Exa...

(UNLIKELY_OPENING_PUNCTUATION)

docs: improve @nuxt/kit documentation

88ad887

github-actions bot added 3.x documentation labels Apr 14, 2025

Mini-ghost and others added 8 commits April 17, 2025 01:48

docs: improve Templates section of @nuxt/kit documentation

baa27f4

[autofix.ci] apply automated fixes

b86c4da

docs: update templates section of @nuxt/kit documentation

5823355

docs: add addServerTemplate to @nuxt/kit documentation

fe2a2af

Merge branch 'main' into docs/improve-nuxt-kit

661d6b9

docs: update Nitro section of @nuxt/kit documentation

d20e30d

docs: update Pages section of @nuxt/kit documentation

04e6520

docs: update Context section of @nuxt/kit documentation

5ab9a42

Mini-ghost force-pushed the docs/improve-nuxt-kit branch from 7d43836 to 5ab9a42 Compare April 21, 2025 08:47

Mini-ghost added 3 commits April 21, 2025 23:26

docs: update Plugins section of @nuxt/kit documentation

a0641a2

docs: update Builder section of @nuxt/kit documentation

fad20ad

docs: unify table column names

f5f6d14

Mini-ghost force-pushed the docs/improve-nuxt-kit branch from dd914a9 to f5f6d14 Compare April 21, 2025 23:06

Mini-ghost added 8 commits April 22, 2025 07:42

docs: update Logging section of @nuxt/kit documentation

1d082ee

docs: update Layout section of @nuxt/kit documentation

e85cc4f

docs: unify table column names

1ce7089

docs: add code highlight

99c7e7d

docs: update Resolving section of @nuxt/kit documentation

82ef687

docs: update Programmatic Usage section of @nuxt/kit documentation

3eb610c

docs: update Compatibility section of @nuxt/kit documentation

f5caeac

docs: minor update

dc7e3eb

Mini-ghost marked this pull request as ready for review April 25, 2025 15:43

Mini-ghost requested a review from danielroe as a code owner April 25, 2025 15:43

coderabbitai bot reviewed Apr 25, 2025

View reviewed changes

docs: add example for addComponent

52a5cce

[autofix.ci] apply automated fixes

7e11e7a

danielroe approved these changes May 2, 2025

View reviewed changes

danielroe merged commit 100070b into nuxt:main May 2, 2025
7 checks passed

danielroe pushed a commit that referenced this pull request May 2, 2025

docs: improve @nuxt/kit documentation (#31793)

dfd2663

This was referenced May 2, 2025

v4.0.0 #27716

Draft

v3.17.2 #31960

Merged

Mini-ghost deleted the docs/improve-nuxt-kit branch May 2, 2025 10:11

Mini-ghost mentioned this pull request Jun 10, 2025

docs: defineNuxtPlugin function documentation #32328

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: improve `@nuxt/kit` documentation #31793

docs: improve `@nuxt/kit` documentation #31793

Uh oh!

Mini-ghost commented Apr 14, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Apr 14, 2025

Uh oh!

coderabbitai bot commented Apr 25, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Apr 25, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

docs: improve @nuxt/kit documentation #31793

docs: improve @nuxt/kit documentation #31793

Uh oh!

Conversation

Mini-ghost commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Apr 14, 2025

Uh oh!

coderabbitai bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

docs: improve `@nuxt/kit` documentation #31793

docs: improve `@nuxt/kit` documentation #31793

Mini-ghost commented Apr 14, 2025 •

edited

Loading

coderabbitai bot commented Apr 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)