nuxt / nuxt/icon

Bundle & CDN providers for serverless environment

Open
#426 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.2k
Forks
96
Avg merge
8h 12m
Merged PRs (30d)
2

Description

Hey there,

I find the docs a bit puzzling on a few points. It first says:

It's highly recommended to install the icon data locally with

npm i -D @iconify-json/collection-name

And later on explains that "Server Bundle Mode: auto is the default for serverless:

This is the default option, where the module will pick between local and remote based your deployment environment. local will be preffered unless you are deploying to a serverless or worker environment, like Vercel Edge or Cloudflare Workers.

So in serverless environments, is it still recommended to locally install the icon sets, if so, why?

Maybe I missed some details, but I thought that might not be clear for everyone.

I'll be happy to improve the docs as soon as it clears out in my brain 🧠

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the documentation passages describing local icon installation and Server Bundle Mode auto, including the serverless examples for Vercel Edge and Cloudflare Workers. Confirm the intended recommendation and explain why the local package is or is not needed in those environments; done means the guidance is consistent and the serverless behavior is unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.