docs: Realign How it works around the hot-reload dev loop#650
Merged
Conversation
Contributor
|
I think this page should function as a "quickstart" to understand how to work with Serverpod. Not how Serverpod works under the hood. What will the user need to know to get started as quickly as possible, without going through the getting-started guide? This is basically the page for more experienced Flutter developers who want to get started quickly. Having a brief introduction at the top, as we do now, is great. But we must also dive a bit deeper into how you define a model and what you can pass to your methods. The old overview covers this pretty neatly. If we can take the good stuff from there and add it into this page, that would be ideal. |
vlidholt
requested changes
Jun 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Realigns the How it works page (#566) to lead with the developer experience, the
serverpod starthot-reload dev loop, rather than internal request mechanics.serverpod create→ why it works → next steps.serverpod createchoices./how-it-works); does not introduce the "Jetstream" brand (per Realign How it works with new the hot-reload workflow #566).Verification
serverpod startbehavior, embedded Postgres as the default (confirmed against a 3.5 project), theserverpod createchoices,client.example.hello, and.spy.yaml.npm run buildlocally (perAGENTS.md). Please confirm the cross-doc links resolve in the build, this page uses a custom/how-it-worksslug, so the slug-form links are worth a build check.Closes #566