vuejs / vuejs/docs

Document create-vue Typescript setup

Open
#2,907 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

It was suggested that this is the best place to document the tsconfig setup output by create-vue. I've written much of this doc already, over at https://github.com/vuejs/create-vue/issues/265, though I need some help with the final parts. Is this something that would belong in the vue.js docs? If so, where?

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 reading create-vue issue #265, where much of the TypeScript documentation is drafted, then review the Vue docs structure to identify its appropriate location. Done means the remaining tsconfig setup guidance is completed and placed in the Vue docs.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.