From 20bcbd9f1906f8a6d58b596322b0b287840fe852 Mon Sep 17 00:00:00 2001 From: Saravanakumar D Date: Sat, 30 May 2026 21:22:21 -0700 Subject: [PATCH] docs(gigafactory): uppercase GIGAFACTORY folder + add index README Rename docs/gigafactory/ to docs/GIGAFACTORY/ and update the cross-repo source-of-truth references in the fleet README and types.ts comment. Add an index README listing the platform docs and pointing to the canonical spec in learning_ai_devops_tools. Docs/comment only; no behavior change. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../FLEET_CONTROL_PLANE.md | 0 docs/GIGAFACTORY/README.md | 21 +++++++++++++++++++ .../ROADMAP_COMPLETION_AUDIT.md | 2 +- .../TASKS_TO_COMPLETE.md | 0 .../gigafactory-phase3-progress.md | 0 .../src/modules/fleet/README.md | 2 +- .../src/modules/fleet/types.ts | 2 +- 7 files changed, 24 insertions(+), 3 deletions(-) rename docs/{gigafactory => GIGAFACTORY}/FLEET_CONTROL_PLANE.md (100%) create mode 100644 docs/GIGAFACTORY/README.md rename docs/{gigafactory => GIGAFACTORY}/ROADMAP_COMPLETION_AUDIT.md (98%) rename docs/{gigafactory => GIGAFACTORY}/TASKS_TO_COMPLETE.md (100%) rename docs/{gigafactory => GIGAFACTORY}/gigafactory-phase3-progress.md (100%) diff --git a/docs/gigafactory/FLEET_CONTROL_PLANE.md b/docs/GIGAFACTORY/FLEET_CONTROL_PLANE.md similarity index 100% rename from docs/gigafactory/FLEET_CONTROL_PLANE.md rename to docs/GIGAFACTORY/FLEET_CONTROL_PLANE.md diff --git a/docs/GIGAFACTORY/README.md b/docs/GIGAFACTORY/README.md new file mode 100644 index 00000000..13a608fb --- /dev/null +++ b/docs/GIGAFACTORY/README.md @@ -0,0 +1,21 @@ +# Gigafactory — Platform Docs + +Planning, status, and operational docs for the **Agent Gigafactory** fleet +backend that lives in this repo (`services/platform-service` fleet module + +the `dashboards/tracker-web` UI). + +## Contents + +| Doc | What it is | +| --- | --- | +| [`ROADMAP_COMPLETION_AUDIT.md`](ROADMAP_COMPLETION_AUDIT.md) | Audit of the current build state against the roadmap: completed / partial / missing features, risks, and prioritized remaining work. | +| [`TASKS_TO_COMPLETE.md`](TASKS_TO_COMPLETE.md) | The actionable, priority-ordered completion checklist that companions the audit. | +| [`gigafactory-phase3-progress.md`](gigafactory-phase3-progress.md) | Phase-3 progress log: per-slice end-state. | +| [`FLEET_CONTROL_PLANE.md`](FLEET_CONTROL_PLANE.md) | Operational guide for running and using the fleet control plane. | + +## Source of truth + +The canonical spec and system overview live in the runner repo, +`learning_ai_devops_tools`, under +`agent-queue/docs/GIGAFACTORY/` (`GIGAFACTORY_ROADMAP.md`, +`GIGAFACTORY_SYSTEM_OVERVIEW.md`). diff --git a/docs/gigafactory/ROADMAP_COMPLETION_AUDIT.md b/docs/GIGAFACTORY/ROADMAP_COMPLETION_AUDIT.md similarity index 98% rename from docs/gigafactory/ROADMAP_COMPLETION_AUDIT.md rename to docs/GIGAFACTORY/ROADMAP_COMPLETION_AUDIT.md index 9aceae84..863a37be 100644 --- a/docs/gigafactory/ROADMAP_COMPLETION_AUDIT.md +++ b/docs/GIGAFACTORY/ROADMAP_COMPLETION_AUDIT.md @@ -1,6 +1,6 @@ # Gigafactory — Roadmap Completion Audit -> Source of truth: `learning_ai_devops_tools/agent-queue/docs/gigafactory/GIGAFACTORY_ROADMAP.md` +> Source of truth: `learning_ai_devops_tools/agent-queue/docs/GIGAFACTORY/GIGAFACTORY_ROADMAP.md` > Audit date: 2026-05-30 · Auditor: Principal Full-Stack review > Scope: `services/platform-service/src/modules/fleet/**` + `dashboards/tracker-web/src/app/dashboard/fleet/**` diff --git a/docs/gigafactory/TASKS_TO_COMPLETE.md b/docs/GIGAFACTORY/TASKS_TO_COMPLETE.md similarity index 100% rename from docs/gigafactory/TASKS_TO_COMPLETE.md rename to docs/GIGAFACTORY/TASKS_TO_COMPLETE.md diff --git a/docs/gigafactory/gigafactory-phase3-progress.md b/docs/GIGAFACTORY/gigafactory-phase3-progress.md similarity index 100% rename from docs/gigafactory/gigafactory-phase3-progress.md rename to docs/GIGAFACTORY/gigafactory-phase3-progress.md diff --git a/services/platform-service/src/modules/fleet/README.md b/services/platform-service/src/modules/fleet/README.md index 6d1ab6e6..e21552db 100644 --- a/services/platform-service/src/modules/fleet/README.md +++ b/services/platform-service/src/modules/fleet/README.md @@ -5,7 +5,7 @@ the durable backend that supersedes the single-host stand-ins built in the `agent-queue` (devops-tools) repo. Everything runs on the `@bytelyst/datastore` abstraction, so all tests execute on `DB_PROVIDER=memory` (no Cosmos/network). -Spec: `../learning_ai_devops_tools/agent-queue/docs/gigafactory/GIGAFACTORY_ROADMAP.md` +Spec: `../learning_ai_devops_tools/agent-queue/docs/GIGAFACTORY/GIGAFACTORY_ROADMAP.md` (§4 core contract, §7 scheduler/claim, §8 factory/lease/heartbeat, §13 containers, §18 failure model, §25 durability/recovery, §26 insights). diff --git a/services/platform-service/src/modules/fleet/types.ts b/services/platform-service/src/modules/fleet/types.ts index 4fcd1b6c..d1655f96 100644 --- a/services/platform-service/src/modules/fleet/types.ts +++ b/services/platform-service/src/modules/fleet/types.ts @@ -7,7 +7,7 @@ * from them (no `any`). * * Field names + lifecycle mirror the agent-queue gigafactory spec - * (../learning_ai_devops_tools/agent-queue/docs/gigafactory/GIGAFACTORY_ROADMAP.md §4/§7/§8/§13). + * (../learning_ai_devops_tools/agent-queue/docs/GIGAFACTORY/GIGAFACTORY_ROADMAP.md §4/§7/§8/§13). */ import { z } from 'zod';