Guides

[teemingc]

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

[hamboomger]

It might be not directly related to the issue, but I honestly I would choose sveltekit documentation every day of the week compared to Django. I've been using Django for the past 2 years and it always takes me 10 business days to extract any relevant information about the thing I need. Maybe it's the line height and the amount of empty space, maybe it's the color palette and font styling in general, or maybe the content itself, but some of the pages just look like a dump of content, with not much structure to it. See Migrations page as an example.

[teemingc]

@hamboomger What about the Svelte docs makes it easy for you to find information? Is there anything you'd like to see that could make it better?

[hamboomger]

@eltigerchino I will compare it to the Django docs and Drizzle ORM docs.

First and the most important thing is, the navigation sidepanel (to the left) in SvelteKit docs is short enough to fit almost everything I need in one screen (albeit 32 inch screen), without the "reference" section. Drizzle ORM's sidepanel is twice as long, and Django has no sidepanel at all, you have to scroll through the wall of text on the main "documentation" page to find the link you need.

The larger the documentation looks, the harder it is to sell to a new developer. Look at the next.js docs page - it's probably a huge framework, but the documentation sidebar is really small.

Second thing is probably the "core concepts" section. The naming for concepts is pretty good and it feels like once you read through this section, you know SvelteKit. In comparison, DrizzleORM's fundamentals section is not nearly enough to understand the Drizzle API, and you still have no idea how to do SQL queries.

Django probably does better job at it with the model/view/template layer sections, but every section has 20+ links in it, which is overwhelming.

I don't know how to make the documentation even better then it is today, to be honest, but if I had to say at least something, it would be that the navigation sidepanel matters a lot. If it had 30% more items, I already would find it overwhelming to read through.

P.S. To clarify, the "reference" section is good IMO, because when looking at the navigation sidepanel, my eyes immediately skip this section, because I know what to expect from it.