You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-3Lines changed: 15 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,14 @@
1
1
# PRD-Driven Delivery Workspace
2
2
3
-
This repo demonstrates how I structure docs-first delivery from product requirements to backend, frontend, QA, and local infrastructure validation.
3
+
This repo demonstrates how I structure docs-first delivery from product requirements to backend, frontend, QA, preview environments, and local infrastructure validation.
4
4
5
5
It is not meant to be a large production clone. It is meant to show a working delivery model:
6
6
7
7
- start with a PRD
8
8
- refine it into a spec
9
9
- drive implementation across `backend`, `frontend`, and `e2e-test`
10
10
- validate the result locally with Docker and k3d
11
+
- expose branch or pull-request previews so reviewers can judge the running result, not just the diff
11
12
- use AI assistance inside that structured workflow instead of treating AI output as the workflow itself
12
13
13
14
The core claim of this workspace is simple:
@@ -21,6 +22,7 @@ The core claim of this workspace is simple:
21
22
- A feature can start in `docs/`, not in source code.
22
23
- Product requirements can be made explicit enough to drive API, UI, and test changes.
23
24
- The same feature can be validated both in local service mode and in a k3s-style environment.
25
+
- Preview URLs can be generated deterministically from a branch or pull request and cleaned up after merge.
24
26
- A single engineer can keep backend, frontend, QA, and infrastructure aligned through shared documents and conventions.
25
27
- AI-assisted workflows can be useful when they are grounded in explicit PRDs, specs, contracts, and validation steps.
26
28
@@ -64,8 +66,8 @@ The current codebase proves the delivery path with a small working slice:
64
66
- Vue rendering of live backend health, business-task intake, and planning-oriented task rows
65
67
- Playwright smoke coverage for API health, API task reads, API task creation, and UI create/read paths
66
68
- Local Docker and `k3d` validation through the Helm chart
67
-
- branch or PR-based preview-environment scripts plus GitHub Actions wiring for deploy, comment, and cleanup
68
-
- local preview dashboard generation and guarded approval-to-merge workflow support
69
+
- branch or PR-based preview-environment scripts plus GitHub Actions wiring for deploy, comment, merge approval, and cleanup
70
+
- local preview URLs on `.localhost` plus dashboard generation for observing active previews
69
71
70
72
## Documented Next Feature
71
73
@@ -218,6 +220,16 @@ make pr-env-dashboard-open
218
220
make pr-env-delete PREVIEW_PR_NUMBER=204
219
221
```
220
222
223
+
## Preview Flow
224
+
225
+
Preview is treated here as part of delivery, not as an infra afterthought.
226
+
227
+
- Each preview is derived from a branch name or pull-request number.
228
+
- The preview namespace, release name, host, and URL are computed deterministically.
229
+
- Local preview rehearsals use `k3d` plus direct `.localhost` URLs for fast visual checks.
230
+
- A small dashboard shows active previews, readiness, and direct links.
231
+
- When a pull request is approved and merged, the preview environment is expected to be removed as part of the same workflow.
0 commit comments