──────
Build and Push Docker Images / detect-changes (push) Successful in 11s
Build and Push Docker Images / build-auth-api (push) Successful in 1m0s
Build and Push Docker Images / build-employee-api (push) Successful in 1m2s
Build and Push Docker Images / build-transit-api (push) Successful in 1m1s
Build and Push Docker Images / build-error-log-api (push) Successful in 1m5s
Build and Push Docker Images / build-admin-ui (push) Successful in 1m13s
Build and Push Docker Images / build-monitoring-ui (push) Successful in 1m15s
Build and Push Docker Images / deploy-test-node (push) Successful in 3s
Build and Push Docker Images / detect-changes (push) Successful in 11s
Build and Push Docker Images / build-auth-api (push) Successful in 1m0s
Build and Push Docker Images / build-employee-api (push) Successful in 1m2s
Build and Push Docker Images / build-transit-api (push) Successful in 1m1s
Build and Push Docker Images / build-error-log-api (push) Successful in 1m5s
Build and Push Docker Images / build-admin-ui (push) Successful in 1m13s
Build and Push Docker Images / build-monitoring-ui (push) Successful in 1m15s
Build and Push Docker Images / deploy-test-node (push) Successful in 3s
### Summary of Changes
1. Documentation Consolidation:
• Relocated the docs/ folder and all repository .md files (README.md, DEPLOYMENT.md, DOCKER_README.md,
DOMAINS_README.md, GETTING_STARTED.md, CI_CD_PORTAINER_GUIDE.md, ADMIN_DEPLOYMENT_SUMMARY.md,
SECURITY_PRIVATE_FILES.md, handoff.md, azure-project-plan.md, plus service-specific READMEs) into .
• Updated document links in README.md.
2. AI Agent Project Map:
• Created PROJECT_MAP.md in the project root containing complete architecture diagrams, service specs, ports, DB
schemas, environment variables, and developer workflows.
• Added PROJECT_MAP.md to .gitignore.
3. Monitoring UI & Infrastructure Integration:
• Added monitoring_ui service to docker-compose.yml (port 5175).
• Configured Gitea workflow docker-build.yml for monitoring_ui builds.
• Added CORS middleware headers in index.js.
• Added nginx.conf copy step in Dockerfile.
──────
### Recommended Commit Message
docs: consolidate project documentation into monitoring_ui and add agent project map
- Move all markdown documentation files and docs/ folder into monitoring_ui/docs/
- Update documentation hub index (monitoring_ui/docs/README.md) with relative paths
- Generate comprehensive AI agent reference map (PROJECT_MAP.md) in repository root
- Add PROJECT_MAP.md and monitoring_ui build output/env overrides to .gitignore
- Integrate monitoring_ui service into docker-compose.yml and Gitea CI workflow
- Configure CORS handling in employee_api for monitoring dashboard access
──────
### Alternative Short Commit Message
refactor(docs): move docs to monitoring_ui and create AI agent PROJECT_MAP.md
This commit is contained in:
@@ -0,0 +1,87 @@
|
||||
<!-- azure-cor-disclaimer -->
|
||||
> **Important:** This skill provides guidance and recommended instructions to assist the AI system. Outputs are not guaranteed to be complete, correct, secure, or applicable to every scenario. Results should be reviewed and validated by a human before being applied. The AI model may choose not to follow all instructions exactly, and additional verification may be required.
|
||||
|
||||
# Sub-Agent Strategy for Backend Scaffolding
|
||||
|
||||
> Parallelization strategy for backend scaffold execution. Read when transitioning from **Step 1** to backend implementation.
|
||||
|
||||
---
|
||||
|
||||
## Execution Model
|
||||
|
||||
> ⚠️ **PIPELINING**: The **Frontend sub-agent** (Step 1) and the backend track both begin **immediately after Step 0** (plan validation) and run **concurrently**. Phase A (Contracts) and Phase B (Backend) derive from the plan, not the frontend, so neither track blocks the other. For API-only projects (no frontend), the Frontend sub-agent is skipped and backend scaffolding proceeds immediately after Step 0.
|
||||
>
|
||||
> **Execution timeline for SPA + API projects:**
|
||||
> ```
|
||||
> Step 0 (Plan Validated)
|
||||
> ├── Frontend Sub-Agent (F1–F4: generate + build) ──> returns ──────────────────────────┐
|
||||
> └── Phase A: Contracts (sequential) ──> Phase B: Backend Sub-Agent ────────────────────┤
|
||||
> ▼
|
||||
> Step 11: Wrap Up
|
||||
> ```
|
||||
>
|
||||
> The Frontend sub-agent generates + builds + verifies `services/web/` (F1–F4) and hands back.
|
||||
|
||||
---
|
||||
|
||||
## Frontend Sub-Agent (parallel with backend)
|
||||
|
||||
Launched right after Step 0 (concurrently with Phase A/B). Owns frontend generation and build.
|
||||
|
||||
| Sub-Agent | Responsibility | Scope |
|
||||
|-----------|---------------|-------|
|
||||
| **Frontend Agent** (general-purpose) | Generate `services/web/`: the `ApiClient` seam (`src/api/` — interface + mock impl + one-line `index.ts` swap point) backed by a mock data layer with real images (F1–F2), pages + shared components that import only the seam `api` object (F3), login UI plus locally seeded identity when `API Login` is `Yes`, and all four data states. Login-enabled frontends MUST include a visible **Create account** button on the login page and a dedicated create-account page wired through `api.createAccount(...)`. When `API Login` is `No`, generate no auth UI or state. **The `ApiClient` interface must cover every entity the UI renders, including reference data the plan has no route for (assignee lookups, the signed-in user) — nothing outside `src/api/` may import `src/mocks/`.** Apply the Rule 13 quality bar + Polish floor. Run the frontend build gate (`npm --prefix services/web run build`, zero errors, no `any`) (F4). | Step 1 sub-steps **F1–F4** |
|
||||
|
||||
**Brief handed to the sub-agent** (full context it receives):
|
||||
- The approved plan, especially **Section 6 (Design System & UI)**: `Component Library:`, `Style Direction:`, `Typography:`, Color Palette, Pages table.
|
||||
- The approved HTML preview under `.azure/.preview-temp/` (manifest + per-page `<slug>.html` + `theme.css`) as the presentation-quality visual spec.
|
||||
- The three frontend reference docs: `frontend-quality-bar.md`, `frontend-patterns.md`, `frontend-preview-steps.md`.
|
||||
|
||||
**Hand-back contract** (what the sub-agent returns):
|
||||
- `services/web/` generated and **building cleanly** (it ran the F1–F4 checkpoints: build passes, no `any`, API Login behavior matches the plan, login-enabled apps have the required create-account button and page, four states present, Rule 13 satisfied).
|
||||
- A short report listing the pages generated and any caveats.
|
||||
- It MUST NOT call `ask_user` for UX approval — the design was already approved during planning.
|
||||
|
||||
---
|
||||
|
||||
## Phase A: Contracts First (BLOCKING — Sequential, No Parallelism)
|
||||
|
||||
Create sequentially — dependencies for everything else:
|
||||
1. Shared types (`services/shared/types/`)
|
||||
2. Validation schemas (`services/shared/schemas/`)
|
||||
3. Service interfaces (`services/functions/src/services/interfaces/`)
|
||||
4. Error types (`services/functions/src/errors/`)
|
||||
5. Config module (`services/functions/src/services/config.ts`)
|
||||
|
||||
Build shared package to produce `dist/`. Verify cross-workspace imports resolve.
|
||||
|
||||
---
|
||||
|
||||
## Phase B: Parallel Implementation via Sub-Agents
|
||||
|
||||
Once contracts exist on disk, launch backend sub-agent:
|
||||
|
||||
| Sub-Agent | Responsibility | Scope |
|
||||
|-----------|---------------|-------|
|
||||
| **Backend API Agent** (general-purpose) | Concrete service implementations, service registry, function handlers, OpenAPI spec, structured logging | Steps 3–10 implementation files |
|
||||
|
||||
> **NOTE**: Testing is NOT part of the scaffold phase. Test infrastructure, mocks, fixtures, and unit tests are out of scope — the scaffold produces correct, buildable production code only. Keeping tests out of scaffold ensures the production code stays focused and is not buried under test scaffolding.
|
||||
|
||||
---
|
||||
|
||||
## Coordination Rules
|
||||
|
||||
- The **Frontend Agent** and the backend track (Phase A → Phase B) launch together after Step 0 and run concurrently.
|
||||
- The **Backend API Agent** receives the full project plan and the contracts created in Phase A as context.
|
||||
- After the Backend agent completes, run the final build gate (`npm run build` in all workspaces).
|
||||
- The scaffold does **not** start a dev server or open Simple Browser — the frontend is generated and built only; running it locally is out of scope for scaffolding.
|
||||
- **Completion gate**: Step 11 (Wrap Up) writes the hand-off artifact only after BOTH: (a) frontend generated and building cleanly — the Frontend sub-agent returned — AND (b) Phase B backend agent completed. If one track finishes first, wait for the other.
|
||||
- Then proceed to Step 11 (Wrap Up)
|
||||
|
||||
---
|
||||
|
||||
## Key Contract Rules
|
||||
|
||||
- Agent MUST use same `AppConfig` shape (flat structure — see [../../shared-references/service-abstraction.md](.github/agents/shared-references/service-abstraction.md))
|
||||
- Agent MUST use same collection names (`'user'`, `'couple'`, etc.) mapping to SQL table names
|
||||
- Agent MUST use same validation schema names exported from `services/shared/schemas/validation.ts`
|
||||
Reference in New Issue
Block a user