docs: Overview - removed all redundant info and reworked it's purpose#457
Open
docs: Overview - removed all redundant info and reworked it's purpose#457
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.
Overview page rewrite
This PR strips the redundant content and rewrites the page as a genuine architectural explanation.
Problem
The Overview page (
docs/02-overview.md) was largely redundant with two other pages:index.md) — already lists Serverpod's key capabilities and features with nearly identical wording.01-get-started/) — already covers endpoints, models, and database usage hands-on, with the same code examples the Overview was repeating.A Diataxis analysis identified the page as an "Explanation attempt" that failed its purpose: instead of explaining how Serverpod works conceptually, it restated marketing bullets and duplicated tutorial code. The endpoint example appeared in three separate places (
index.md,02-overview.md, and the get-started tutorial).On the other hand, no page in the docs explained:
Session.All these things are essential for a user to understand to work confidently with Serverpod.
Solution
index.md. Removed.index.md. Removed.index.mdand the get-started tutorial. Removed.sidebar_label→ "How it works", heading → "# How Serverpod works"._clientis never edited by hand.serverpod generatereads and produces. Includes a Mermaid flowchart..spy.yamlas the single source of truth and what that means for compile-time safety.