Skip to content

Commit 78d3a82

Browse files
committed
docs: document preview delivery flow
1 parent 9563627 commit 78d3a82

2 files changed

Lines changed: 23 additions & 8 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# AGENTS.md - Example Workspace
1+
# AGENTS.md - PRD-Driven Delivery Workspace
22

3-
This workspace is a simplified example for a multi-project development setup.
3+
This workspace is a docs-first delivery workspace with backend, frontend, QA, and preview-environment touchpoints.
44

55
## Structure
66

77
| Directory | Role |
88
|-----------|------|
9-
| `docs/` | PRD and spec documents |
9+
| `docs/` | PRD, spec, and preview-flow documents |
1010
| `backend/` | Kotlin Spring Boot API |
1111
| `frontend/` | Vue 3 web app |
1212
| `database/` | MariaDB and bootstrap SQL |
1313
| `e2e-test/` | Playwright smoke tests |
14-
| `infrastructure/` | k3s test environment templates |
14+
| `infrastructure/` | k3s/k3d templates, preview scripts, and Helm chart |
1515

1616
## Working Principles
1717

@@ -21,6 +21,8 @@ This workspace is a simplified example for a multi-project development setup.
2121
4. When the API changes, also review `frontend/src/api/` and `e2e-test/tests/`.
2222
5. When the test environment changes, update `infrastructure/k3s/helm/example-stack` and `infrastructure/k3s/scripts` together.
2323
6. On macOS with Docker Desktop, prefer validating the k3s flow through `k3d` unless the user explicitly wants Docker Desktop Kubernetes.
24+
7. Preview changes should update the PRD/spec package, GitHub workflows, Helm values/templates, and preview scripts together.
25+
8. Treat preview as part of the delivery flow: branch or PR input, live URL, smoke check, approval/merge, then cleanup.
2426

2527
## Common Commands
2628

@@ -36,10 +38,11 @@ make helm-smoke-local
3638
make helm-template
3739
make pr-env-create-local PREVIEW_PR_NUMBER=204
3840
make pr-env-test PREVIEW_PR_NUMBER=204
41+
make pr-env-dashboard
3942
make pr-env-dashboard-open
4043
make pr-env-delete PREVIEW_PR_NUMBER=204
4144
```
4245

4346
## Goal
4447

45-
Keep the workspace minimal and readable while making the PRD -> SPEC -> CODE -> QA flow visible enough to evaluate.
48+
Keep the workspace minimal and readable while making the PRD -> SPEC -> CODE -> QA -> preview flow visible enough to evaluate.

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# PRD-Driven Delivery Workspace
22

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.
44

55
It is not meant to be a large production clone. It is meant to show a working delivery model:
66

77
- start with a PRD
88
- refine it into a spec
99
- drive implementation across `backend`, `frontend`, and `e2e-test`
1010
- 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
1112
- use AI assistance inside that structured workflow instead of treating AI output as the workflow itself
1213

1314
The core claim of this workspace is simple:
@@ -21,6 +22,7 @@ The core claim of this workspace is simple:
2122
- A feature can start in `docs/`, not in source code.
2223
- Product requirements can be made explicit enough to drive API, UI, and test changes.
2324
- 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.
2426
- A single engineer can keep backend, frontend, QA, and infrastructure aligned through shared documents and conventions.
2527
- AI-assisted workflows can be useful when they are grounded in explicit PRDs, specs, contracts, and validation steps.
2628

@@ -64,8 +66,8 @@ The current codebase proves the delivery path with a small working slice:
6466
- Vue rendering of live backend health, business-task intake, and planning-oriented task rows
6567
- Playwright smoke coverage for API health, API task reads, API task creation, and UI create/read paths
6668
- 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
6971

7072
## Documented Next Feature
7173

@@ -218,6 +220,16 @@ make pr-env-dashboard-open
218220
make pr-env-delete PREVIEW_PR_NUMBER=204
219221
```
220222

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.
232+
221233
## Workspace Commands
222234

223235
```bash

0 commit comments

Comments
 (0)