blitz-js / blitz-js/blitzjs.com

Improve `Basics` section in the docs

Open
#766 0 comments 0 reactions 0 assignees View on GitHub
status/ready-to-work-on
Dominant language
MDX
Stars
188
Forks
316
PR merge metrics
No merged PRs in 30d

Description

Part of https://github.com/blitz-js/blitz/issues/3828

Go over each page and see how it can be improved:
- Is there a guide?
- Is the API covered?
- Make sure that the information is correct and up to date with the Blitz 2.0

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the pages in the docs' Basics section and compare each one with Blitz 2.0. Check whether each page has a guide, covers its API, and remains accurate; done means every Basics page has been reviewed and the needed documentation updates are identified or made.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.