Skip to content

docs: improve bundling documentation#498

Merged
harlan-zw merged 2 commits intomainfrom
issue-466-bundle-documentation
Sep 22, 2025
Merged

docs: improve bundling documentation#498
harlan-zw merged 2 commits intomainfrom
issue-466-bundle-documentation

Conversation

@harlan-zw
Copy link
Collaborator

@harlan-zw harlan-zw commented Sep 18, 2025

🔗 Linked issue

#466

❓ 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

Make it clearer that bundling requires static script src.

Add comprehensive documentation covering build-time vs runtime behavior, static URL requirements, manual injection patterns, and limitations with workarounds.

- Add Build-time vs Runtime Behavior section explaining bundling process
- Add Static URL Requirements with clear examples of valid/invalid patterns
- Add Manual Injection Patterns for dynamic scenarios
- Add Working with Dynamic URLs with multiple strategies
- Expand Limitations and Workarounds section with technical details
- Include practical code examples for common use cases

This addresses Phase 1 of Issue #466 - Bundle Documentation improvements.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link
Contributor

vercel bot commented Sep 18, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
scripts-docs Ready Ready Preview Comment Sep 22, 2025 3:25am
scripts-playground Ready Ready Preview Comment Sep 22, 2025 3:25am

@pkg-pr-new
Copy link

pkg-pr-new bot commented Sep 18, 2025

Open in StackBlitz

npm i https://pkg.pr.new/nuxt/scripts/@nuxt/scripts@498

commit: de5266a

@harlan-zw harlan-zw marked this pull request as ready for review September 22, 2025 03:22
@harlan-zw harlan-zw merged commit 4854b4c into main Sep 22, 2025
7 of 8 checks passed
@harlan-zw harlan-zw deleted the issue-466-bundle-documentation branch September 22, 2025 03:27
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.

1 participant

Comments