Skip to content

Commit 516811d

Browse files
committed
feat(docs): update documentation for final MVP verification and deployment processes
1 parent 12a2178 commit 516811d

16 files changed

Lines changed: 46 additions & 20 deletions

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ help:
3131
@echo " make format Format with Black and Ruff"
3232
@echo " make format-check Check formatting"
3333
@echo " make migrations-check Check for missing migrations"
34+
@echo " make deploy-check Run Django production deploy check"
3435
@echo " make check Run lint, format-check, migrations check, deploy check, and tests"
3536
@echo " make clean Remove Python and test cache files"
3637

RUNBOOK.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -190,18 +190,19 @@ make nltk-data
190190
## Sprint Verification
191191

192192
The executable scripts under `docs/sprint-runbook/` capture incremental sprint
193-
checkpoints. Use the Sprint 3 Day 5 script as the current Sprint 3 completion
194-
check:
193+
checkpoints. Use the Sprint 4 Day 5 script as the current final MVP
194+
verification check:
195195

196196
```bash
197-
./docs/sprint-runbook/sprint-3/sprint-3-day-5.sh
197+
./docs/sprint-runbook/sprint-4/sprint-4-day-5.sh
198198
```
199199

200200
It verifies the Docker Compose project name, the web container, PostgreSQL,
201-
migrations, insight browser routes, secured insight API routes, authentication
202-
and ownership boundaries, NLTK preprocessing, TF-IDF cosine scoring,
203-
explainability fields, idempotency, formatting, linting, focused insight tests,
204-
and the full regression suite.
201+
migrations, documentation coverage, deterministic seed data, production deploy
202+
settings, collectstatic, health checks, browser and API smoke paths,
203+
authentication and ownership boundaries, NLTK preprocessing, TF-IDF cosine
204+
scoring, explainability fields, idempotency, formatting, linting, focused
205+
release tests, and the full regression suite.
205206

206207
See `docs/sprint-runbook/README.md` before running an earlier checkpoint script.
207208

apps/insights/migrations/0001_initial.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Create the target role profile and job insight tables."""
2+
13
# Generated by Django 5.1.15 on 2026-06-08 11:38
24

35
import django.core.validators

apps/insights/migrations/0002_jobinsight_weighted_evidence.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Add weighted evidence storage to generated job insights."""
2+
13
from django.db import migrations, models
24

35

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"""Migration package for the insights app."""

apps/jobs/migrations/0001_initial.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Create the initial jobs domain tables."""
2+
13
# Generated by Django 5.1.15 on 2026-05-28 10:44
24

35
import django.db.models.deletion

apps/jobs/migrations/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"""Migration package for the jobs app."""

apps/roles/migrations/0001_initial.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Create the initial roles table."""
2+
13
# Generated by Django 5.1.15 on 2026-04-30 09:13
24

35
from django.db import migrations, models

apps/roles/migrations/0002_role_code_alter_role_options_and_more.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Add stable role codes and update role metadata."""
2+
13
# Generated by Django 5.1.15 on 2026-05-26 09:45
24

35
import re

apps/roles/migrations/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"""Migration package for the roles app."""

0 commit comments

Comments
 (0)