vuejs / vuejs/docs

Iterate on docs around CDN usage

Open
#1,957 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

The Problem

While there are docs that explain the limitation of single file components to build tools (and not CDN), there could be additional docs and language clarification to help people who may be coming in directly on techniques like script setup and trying to use that within the context of a CDN usage of Vue.

Proposed Solution

  1. Analyze common entry points for techniques that rely on SFC compilation / compilers for opportunities to improve clarity around people who may be using a CDN solution.

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing the existing documentation on single-file components, script setup, SFC compilation, and CDN usage. Trace common entry points where readers may move from compiler-based techniques to a CDN, then clarify the relevant guidance and verify that the updated docs distinguish supported CDN usage from compiler-dependent approaches.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.