Skip to content

Commit 9642cff

Browse files
committed
Adjust Migrations doc
1 parent 5379ea4 commit 9642cff

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

docs/migrations.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,9 @@
1-
# Build your App
2-
3-
## Project Structure
4-
5-
```
6-
📁 bin/ → Helper scripts (e.g. wrappers for CLI tools)
7-
📁 caddy/ → Custom Caddy configuration and certificates
8-
📁 docs/ → Markdown files for SuperStack documentation
9-
📁 postgres/ → SQL migrations and configuration of the postgres container
10-
📄 compose.yaml → Main Docker Compose config
11-
📄 compose.override.yaml → Optional local overrides (development only)
12-
📄 example.env → Example environment variables — copy to `.env`
13-
📄 LICENSE → License file (MIT)
14-
📄 logo.png → SuperStack logo for README/docs
15-
📄 mkdocs.yml → MkDocs configuration for documentation site
16-
📄 README.md → Overview and quick start for the repository
17-
```
18-
19-
## 📜 Migrations
1+
# 📜 Migrations
202

213
SuperStack includes a simple built-in system for managing database schema
224
migrations.
235

24-
### ✍️ Writing Migrations
6+
## ✍️ Writing Migrations
257

268
Place your migration scripts in:
279

@@ -36,7 +18,7 @@ Each file should be:
3618
- Written in plain SQL
3719
- But can include environment variables.
3820

39-
### ▶️ Applying Migrations
21+
## ▶️ Applying Migrations
4022

4123
When the Postgres container starts with no existing data, SuperStack will
4224
automatically run migrations once.
@@ -59,7 +41,7 @@ Already-applied scripts are skipped on subsequent runs.
5941

6042
> 💡 `bin/postgres` is short for `docker compose exec postgres`
6143
62-
### 🔁 Transactions
44+
## 🔁 Transactions
6345

6446
Use `BEGIN;` and `COMMIT;` to wrap migration files when all included
6547
statements are transactional. This ensures that all changes are applied
@@ -108,7 +90,7 @@ DISCARD ALL
10890
LOAD
10991
```
11092

111-
### 🔄 Nuke Everything
93+
## 🔄 Nuke Everything
11294

11395
If you want to start fresh, wipe your database and re-run all migrations from
11496
scratch:

0 commit comments

Comments
 (0)