Skip to content

docs: Reshape Server fundamentals + add Configuration reference#672

Open
developerjamiu wants to merge 9 commits into
mainfrom
concepts-phase2-pr1-server-fundamentals
Open

docs: Reshape Server fundamentals + add Configuration reference#672
developerjamiu wants to merge 9 commits into
mainfrom
concepts-phase2-pr1-server-fundamentals

Conversation

@developerjamiu

@developerjamiu developerjamiu commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Phase 2 IA, PR 1 of 7 (tracked in #671): reshapes the Server fundamentals pages into concept pages and stands up a Configuration reference.

What changed

  • Running your server (00-start-command): reshaped from a flag reference into a concept page about the development loop, hot reload, migrations from the terminal, and run modes. The exhaustive flag tables now live in the CLI reference, which the page links to.
  • Configuration: split into a concept page (how configuration works, the config files, Dart config, secrets, and code generation) and a new Configuration reference holding the exhaustive option tables.
  • Sessions and Modules: light conformance (page titles, descriptions, cross-links). Modules now points at Configuration for the generator.yaml module options instead of repeating them.

Correctness fixes

  • Removed the --flutter-device and --flutter-option flags (they do not exist in the CLI) and corrected the --flutter description, in both the page and the CLI reference.
  • Removed the inheritance experimental feature from the docs; it is a stable feature now (the experimental feature set is all only).
  • Updated the github, google, and facebook auth-provider links after the Configuration headings were reorganized.

Verification

The Configuration reference tables were checked row-by-row against the framework config source (serverpod_shared/lib/src/config.dart and environment_variables.dart): all environment-variable names, config-file keys, and defaults match. Three keys that were missing have been added with verified defaults: database.dialect (postgres), database.dataPath (embedded Postgres), and validateHeaders (true). healthCheckInterval and experimentalDiagnosticHandlerTimeout are Serverpod() constructor arguments, not config-file options, so they are intentionally not in the table.

Notes

  • Structural changes (grouping pages into sidebar categories, the section rename, redirects) are intentionally deferred to the final PR of this series, so this PR keeps every page at its current URL.

Closes #664.

@developerjamiu developerjamiu self-assigned this Jul 6, 2026
@developerjamiu developerjamiu requested a review from Zfinix July 6, 2026 11:57
@developerjamiu developerjamiu added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 6, 2026
Comment thread docs/06-concepts/07-configuration.md Outdated
Comment thread docs/06-concepts/00-start-command.md Outdated
Comment thread docs/06-concepts/lookups/configuration-reference.md Outdated
Comment thread docs/06-concepts/07-configuration.md Outdated
@developerjamiu developerjamiu requested a review from Zfinix July 6, 2026 16:31
Comment thread docs/06-concepts/07-configuration.md Outdated
@developerjamiu developerjamiu requested a review from Zfinix July 6, 2026 19:11

@Zfinix Zfinix left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 🚀 Approved but a rebase is needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reduce duplication: make 00-start-command.md concept-like, link to CLI reference start page

2 participants