docs: Add project anatomy page and deepen the Server fundamentals section#687
Open
developerjamiu wants to merge 1 commit into
Open
docs: Add project anatomy page and deepen the Server fundamentals section#687developerjamiu wants to merge 1 commit into
developerjamiu wants to merge 1 commit into
Conversation
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.
Deep review and rework of the Server fundamentals section, with every technical claim verified against the Serverpod 4.0.0-beta.0 source and a project created with the 4.0.0-beta.0 CLI.
New page
serverpod creategenerates. Starts with the three-package mental model and a short tree, with the full annotated workspace tree in a collapsible. Covers package relations (pub workspace, dependency direction), where user code lives vs generated code, the server entry point (bin/main.dart,run(),pod.start()), the three servers and their ports, the config and migrations directories, the.serverpodembedded-database directory, and the editor/agent files.Reworked pages
--docker, single-instance behavior, run-mode gating of app launches, and new "Run the server directly" and "Choose a server role" sections (monolith / serverless / maintenance semantics). Documents the key notation precisely: shortcuts are unshifted presses, Shift variants are written out, and Shift+M / Shift+P force a migration even past data-loss warnings. Notes that P is not shown in the bottom bar.websocketPingIntervalexample nesting (it is a top-level key; the nested form was silently ignored). Adds a Run modes section, embedded PostgreSQL under Database backends, the SQLite session-log limitation, dedicated secret environment variables with their precedence, and aligns the example with the scaffoldedconfig/development.yaml. Secrets are restructured example-first.AuthUserlives inserverpod_auth_core; references resolve by effective nickname only, and an override replaces the default), pins beta versions exactly, and rewrites the overview reader-first.Reference and consistency fixes
consoleEnabled/consoleLogFormatdefaults, new Dart-only options (healthCheckInterval,experimentalDiagnosticHandlerTimeout), and password environment variables.serverpod start's automatic generation;serverpod generateremains as the no-session path.