Skip to content

docs: Rework Introduction page and remove Overview#495

Open
developerjamiu wants to merge 2 commits into
mainfrom
docs/replace-overview
Open

docs: Rework Introduction page and remove Overview#495
developerjamiu wants to merge 2 commits into
mainfrom
docs/replace-overview

Conversation

@developerjamiu
Copy link
Copy Markdown
Contributor

@developerjamiu developerjamiu commented May 12, 2026

Summary

The Overview page (docs/03-overview.md) largely duplicated the Introduction page. This consolidates them into a single, sharper Introduction:

  • Tightened the opening paragraph to a clear one-liner about what Serverpod is.
  • Kept the server endpoint + Flutter client code example under a new heading, Write Dart everywhere.
  • Added a Who Serverpod is for section (Flutter teams that want a Dart-only stack).
  • Replaced the prose feature dump with a concise What's included bullet list (code gen, dev loop, ORM, client-side DB, auth, streams, deployment, logging, file uploads, scheduling, caching, web server).
  • Added title and description frontmatter for meta/SEO.
  • Deleted docs/03-overview.md. No inbound links pointed to it; Docusaurus auto-pagination links readers to Installation next.

Image

image

Test plan

  • npm run build passes (no broken links).
  • Render /next locally and confirm the page reads well end to end.
  • Confirm the sidebar no longer shows an "Overview" entry.

Copy link
Copy Markdown
Contributor

@Swiftaxe Swiftaxe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@developerjamiu developerjamiu self-assigned this May 13, 2026
@developerjamiu developerjamiu added the enhancement New feature or request label May 13, 2026
Copy link
Copy Markdown
Contributor

@vlidholt vlidholt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions for changes.

Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
@developerjamiu developerjamiu removed the request for review from marcelomendoncasoares May 13, 2026 09:06
@developerjamiu developerjamiu force-pushed the docs/replace-overview branch from 6443b27 to 2b932a5 Compare May 13, 2026 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants