sveltejs / sveltejs/kit

UML Activity Diagram

Open
#7,135 1 comment 3 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

Describe the problem

Simply, it would be necessary to accompany the SvelteKit documentation with a "UML Activity Diagram" that shows the passage of data (locals, data, ecc) between server and client (also the prerendering phase) through all the various possible path phases marked by the various file hooks..js, +page.js, +page*.svelte, etc.
This would greatly facilitate the understanding of SvelteKit making it easier to learn.
Especially with the new changes.
Learning the basics of SvelteKit needs to be very quick.
Even if substantial changes occur, one must quickly figure out how to adapt.
The same kind of diagram should be done for understanding how libraries work.
This type of diagram allows you to speed up the understanding of Sveltekit by a good 20% and should not be very complicated to make.

Describe the proposed solution

In the introduction section
https://kit.svelte.dev/docs/introduction

between "Wath is SvelteKit" and "Getting started" or as an appendix, as the last item on the menu, i wish there was this diagram that I can consult whenever I want to design something with SvelteKit.

Alternatives considered

No response

Importance

would make my life easier

Additional Information

Lately I have found myself having to rewrite and rethink things already done. It's part of the game as SvelteKit is still unstable.
Such a diagram would have been very useful to me (it would have saved me some time) and I think it would have been just as useful to me when I first started using SvelteKit.

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 with the SvelteKit introduction documentation at https://kit.svelte.dev/docs/introduction and map the data flow described in the issue across server, client, prerendering, file hooks, +page*.js, and +page*.svelte. Done means a UML Activity Diagram is added in the introduction or as an appendix and clearly covers the relevant paths, including the stated library-understanding diagram if that remains in scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.