From 42de64f6d42fd469a857361afa762bb51b24620e Mon Sep 17 00:00:00 2001 From: Anto Subash Date: Tue, 12 May 2026 23:42:37 +0200 Subject: [PATCH] docs(cli): align preset module lists with actual `smpy new` behavior The installation and quickstart docs described `--preset standard` as including `permissions`, `settings`, and `feature_flags`, but the CLI's `PRESETS` in `framework/cli/simple_module_cli/catalog.py` resolves `standard` to just `auth, users, dashboard, permissions`. Update the docs to match what the CLI actually does, and note that `simple_module_settings` ships as a hard-coded baseline dep of every scaffolded host (which is why it lands in the venv regardless of preset). Fixes #136 --- docs/guide/installation.md | 8 +++++--- docs/guide/quickstart.md | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/guide/installation.md b/docs/guide/installation.md index afc6b6ee..9ef225a6 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -52,9 +52,11 @@ smpy new myapp --preset standard --with background_tasks,file_storage | Preset | Modules | |---|---| -| `minimal` | `auth`, `users`, `permissions` | -| `standard` (default) | `minimal` + `dashboard`, `settings`, `feature_flags` | -| `full` | `standard` + `background_tasks`, `file_storage` | +| `minimal` | `auth`, `users` | +| `standard` (default) | `minimal` + `dashboard`, `permissions` | +| `full` | `standard` + `settings`, `feature_flags`, `file_storage`, `background_tasks` | + +`simple_module_settings` is also installed as a baseline dependency of every scaffolded host (regardless of preset), so the Settings admin UI is available even in `minimal`. Dependencies between modules are resolved automatically — e.g. `users` always pulls in `auth`. After scaffolding, `smpy new` runs `uv sync`, `npm install`, and `alembic upgrade head` for you (skip with `--no-install` if you'd rather drive that yourself). diff --git a/docs/guide/quickstart.md b/docs/guide/quickstart.md index f34321a1..04eb12bb 100644 --- a/docs/guide/quickstart.md +++ b/docs/guide/quickstart.md @@ -17,7 +17,7 @@ smpy new myapp --yes cd myapp ``` -`--yes` accepts the defaults (SQLite, no multi-tenancy, the `standard` preset: `auth`, `users`, `permissions`, `dashboard`, `settings`, `feature_flags`). The CLI runs `uv sync`, `npm install`, and `alembic upgrade head` for you. +`--yes` accepts the defaults (SQLite, no multi-tenancy, the `standard` preset: `auth`, `users`, `dashboard`, `permissions`, plus `settings` as a baseline). The CLI runs `uv sync`, `npm install`, and `alembic upgrade head` for you. For an interactive run with prompts, drop the `--yes`. For a preset + extras: `smpy new myapp --preset standard --with background_tasks,file_storage --yes`.