Skip to content

docs(README): document extendable layer setup for Nuxt projects#448

Merged
atinux merged 4 commits into
nuxt:mainfrom
mkucmus:patch-1
May 4, 2026
Merged

docs(README): document extendable layer setup for Nuxt projects#448
atinux merged 4 commits into
nuxt:mainfrom
mkucmus:patch-1

Conversation

@mkucmus

@mkucmus mkucmus commented Dec 5, 2025

Copy link
Copy Markdown
Contributor

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Added instructions for using Nuxt as an extendable layer with createResolver

@mkucmus
docs(README): document extendable layer setup for Nuxt projects
9b226b2 
Added instructions for using Nuxt as an extendable layer with createResolver
antfu
antfu requested changes Dec 8, 2025
View reviewed changes

@antfu antfu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I wonder if we could just always suggest using the resolve in the example, instead of duplicating the session twice, which can be confusing to read.

@mkucmus

mkucmus commented Dec 8, 2025

Copy link
Copy Markdown
Contributor Author

I wonder if we could just always suggest using the resolve in the example, instead of duplicating the session twice, which can be confusing to read.

good idea, it's added 🙌🏼

@mkucmus
mkucmus requested a review from antfu December 8, 2025 07:44
atinux
atinux reviewed May 4, 2026
View reviewed changes
Comment thread README.md Outdated
atinux
atinux reviewed May 4, 2026
View reviewed changes
Comment thread README.md Outdated
@atinux
atinux merged commit 9cf019a into nuxt:main May 4, 2026
3 checks passed
@coderabbitai

coderabbitai Bot commented May 4, 2026 •
edited
Loading

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6fe8b301-6780-460d-a108-0fcf49ecc35b

📥 Commits

Reviewing files that changed from the base of the PR and between bba56f9 and f6c5bad.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

Updated the README "Custom Local Collections" example to resolve icon.customCollections[].dir using Nuxt's createResolver/resolve() (via createResolver(import.meta.url)) instead of a literal './assets/my-icons' string. Added a NOTE clarifying this ensures icon asset paths resolve relative to the project when the module is used as an extendable Nuxt layer.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly describes the main documentation change: adding setup instructions for using the Nuxt project as an extendable layer.
Description check ✅ Passed The PR description is related to the changeset, explaining that it adds instructions for using Nuxt as an extendable layer with createResolver.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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
Review rate limit: 6/8 reviews remaining, refill in 11 minutes and 49 seconds.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@atinux atinux atinux approved these changes
@antfu antfu Awaiting requested review from antfu
+1 more reviewer
@patzick patzick patzick approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mkucmus @atinux @antfu @patzick