QwikDev / QwikDev/qwik

📃 Update "Getting Started Guide"

Open
#6,650 1 comment 0 reactions 1 assignee View on GitHub

@thejackshelton is already working on this.

Since Jul 15, 2024.

docs good first issue PR welcomed
Dominant language
TypeScript
Stars
22.1k
Forks
1.4k
Avg merge
1d 10h
Merged PRs (30d)
52

Description

  1. Remove the "Intro part" of "resumable" etc....

  2. In the "install" part - change to "tabs" that show "in browser" / "local installation"

  3. Start with "What are you going to learn in this guide"

  4. Add a "creating a regular component" section, maybe to show a specific joke in a dedicated "Joke" component (to show the difference between "Route components" and regular ones.
    Should probably go after the "loading data" section.

  5. We should have a "learn more" sub section in the end of each section, and the links there must be relevant to the current section

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.