"How to read the docs" section
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start by reviewing the existing “Getting Started with Blitz - Learning” section and the related issue #170 to understand the current documentation structure. Done should be a clearly placed “How to read the docs” section that helps users find relevant sections from practical questions, with the proposed database examples or similarly concrete guidance.
Written by the indexing model from the issue text.
Description
hey,
It would be cool to have a kind of "How to read the docs" section somewhere :)
As a starter (as well as an advanced user) you could find your way to the right section based on questions. A simple example:
- How do I maintain the database? -> "Database"
- How do I use the database? ->"Queries & Mutations"
This may be related to #170 and the Getting Started with Blitz - Learning section.
antony :)
- Dominant language
- MDX
- Stars
- 187
- Forks
- 317
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from blitz-js/blitzjs.com
-
invalid route/link in docs/rpc-setupPossibly taken @justinbalaguer claimed this 715 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 45/100
blitz-js/blitzjs.com#866 ·
-
status/triage
Difficulty 3/5 1-2 days Newbie friendliness 35/100
blitz-js/blitzjs.com#850 ·
-
status/triage
Difficulty 4/5 3-5 days Newbie friendliness 35/100
blitz-js/blitzjs.com#849 · 1 comment ·
-
status/ready-to-work-on
Difficulty 3/5 1-2 days Newbie friendliness 25/100
blitz-js/blitzjs.com#856 · 2 comments ·
-
status/triage
Difficulty 1/5 Under an hour Newbie friendliness 50/100
blitz-js/blitzjs.com#836 ·
All issues in blitz-js/blitzjs.com
Similar issues
-
sync-en
Difficulty 1/5 Under an hour Newbie friendliness 75/100
Maintainers usually reply within 2 days
-
📘 Docs supabase/cli
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
Maintainers usually reply within 1 day
-
[FAQ] Commit ID for ProjectsPossibly taken @github-actions claimed this today. Openfaq-proposal
Difficulty 1/5 Under an hour Newbie friendliness 84/100
DataTalksClub/faq#503 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
KhronosGroup/Vulkan-Tutorial#534 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
open-policy-agent/opa#9426 ·
Maintainers usually reply within 1 day