sveltejs / sveltejs/kit

Guides

Open
#14,316 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
20.8k
Forks
2.3k
Avg merge
1d 16h
Merged PRs (30d)
156

Description

Overall, I think the Kit docs are very nice, and I really appreciate that they are correct and factual and explaining.
In this particular issue, my feeling is: "Why do I have to go to Advanced > Hooks > handleFetch in order to figure this out?".
A) This shouldn't be under "Advanced", since this is basic information that is required to produce a functioning result.
B) If you don't know what the solution is, then you don't know that you should be looking at "Hooks".
Ideally, it would be good to have more docs that are complete step-by-step guides that include everything needed to achieve a certain result. But I know that this takes much more work to write and maintain.
As an example, the Django docs organization is often cited as a best-in-class example of this: https://docs.djangoproject.com/en/5.2/#how-the-documentation-is-organized

Btw, I made a mistake in my previous comment, it seems like ORIGIN is also needed in my case. Thanks for the info on that!

Originally posted by @thnee in #8314

I think the comment referenced has a point, we could do with more guides. An example of this is https://docs.astro.build/en/getting-started/ that is more focused on "how do I do X" rather than "we have X Y Z". I think there's room for both rather than one or the other but we are lacking in guides

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.

Research direction

Start by reviewing the existing Advanced > Hooks > handleFetch documentation and the referenced SvelteKit issue comment. Compare the current organization with Django's documentation structure and Astro's getting-started guides; done requires an agreed scope and new step-by-step guides for selected workflows, but this issue does not identify which workflows or files to change.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.