Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ on:
- "mcp-server/README.md"
- "telemetry-receiver/README.md"
- "CHANGELOG.md"
- "AGENTS.md"
- "CLAUDE.md"
- "LICENSE"
- "specs/**/outreach.md"
Expand Down Expand Up @@ -345,10 +346,11 @@ jobs:
- 'charts/gameplane/Chart.yaml'
# Non-docs/ link targets referenced from the audited files
# (docs/dependencies.md -> CHANGELOG.md, docs/contributing.md
# -> CLAUDE.md and specs/012-.../outreach.md, README.md ->
# -> AGENTS.md and specs/012-.../outreach.md, README.md ->
# LICENSE, signing/cosign.pub, docs/key-rotation.md -> the legacy key
# files) — renaming or moving any of these must run check-links.
- 'CHANGELOG.md'
- 'AGENTS.md'
- 'CLAUDE.md'
- 'LICENSE'
- 'signing/cosign.pub'
Expand Down
4 changes: 2 additions & 2 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ go.work links all 17 Go modules (incl. test/e2e)
Makefile canonical task runner
```

After cloning: `git submodule update --init` (`modules/` required for `make dev-up`; `website/` optional).
After cloning: `git submodule update --init modules` (required for `make dev-up`); add `git submodule update --init website` only when working on the website.

## Commands (always via Makefile)
## Commands (via Makefile; compile checks excepted, see rule 8)

- **Dev:** `make dev-up` (Kind + OCI registry :5001 + Helm), `make web-dev` (Vite, proxies in-cluster API), `make dev-load` (load built images; run `make images` first), `make dev-install` (Helm upgrade), `make dev-down`.
- **Build:** `make build` (all Go + web), `make build-go` (15 modules in GO_MODULES, all but test/e2e), `make build-web` (`npm ci && npm run build`), `make images`.
Expand Down
2 changes: 1 addition & 1 deletion specs/028-split-big-packages/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ v1 is the 20 audit issues #712–#731 plus codebase cleanup, with no new feature
defines the target layout; this spec applies it to the code. Spec 029 (faster e2e buckets)
waits for spec 023.

Target layout, settled in spec 027 (`specs/027-contributor-docs-layout-map/OPEN-DECISIONS.md`,
Target layout, settled in spec 027 (`specs/done_027-contributor-docs-layout-map/OPEN-DECISIONS.md`,
valgul 2026-10-20). This spec applies it and does not reopen it:

- **027 OD-3, Go modules.** Long-running services use a thin `cmd/main.go` plus
Expand Down
2 changes: 1 addition & 1 deletion specs/028-split-big-packages/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "Task list for 028 split big packages and files"
## Phase 1: Setup

- [X] T001 Settle OD-1..OD-10 in `OPEN-DECISIONS.md` and fold them into spec, plan and these tasks (valgul, 2026-10-20/21)
- [ ] T002 Confirm spec 027's `docs/layout.md` has merged to master (027 implementation PR); if not, follow `specs/027-contributor-docs-layout-map/OPEN-DECISIONS.md` and cite it in every brief
- [ ] T002 Confirm spec 027's `docs/layout.md` has merged to master (027 implementation PR); if not, follow `specs/done_027-contributor-docs-layout-map/OPEN-DECISIONS.md` and cite it in every brief
- [ ] T003 Re-measure on current master: production files over 500 lines (Go, web), files per package for `api/internal/handlers` and `operator/internal/controller`, and record the SHA and numbers at the top of `research.md`

## Phase 2: Foundational (blocks every move PR)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Branch**: `claude/project-thread-yulzhu` (spec docs) | **Date**: 2026-10-20 | **Spec**: [spec.md](./spec.md)

**Input**: Feature specification from `specs/027-contributor-docs-layout-map/spec.md`
**Input**: Feature specification from `specs/done_027-contributor-docs-layout-map/spec.md`

## Summary

Expand Down Expand Up @@ -87,7 +87,7 @@ New section near the top of `docs/contributing.md` per [contracts/first-pr-secti
### Documentation (this feature)

```text
specs/027-contributor-docs-layout-map/
specs/done_027-contributor-docs-layout-map/
├── spec.md
├── OPEN-DECISIONS.md
├── research.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Task list for spec 027: contributor docs and layout map"

# Tasks: Contributor Docs and Layout Map

**Input**: Design documents from `specs/027-contributor-docs-layout-map/`
**Input**: Design documents from `specs/done_027-contributor-docs-layout-map/`

**Prerequisites**: [plan.md](./plan.md), [spec.md](./spec.md), [research.md](./research.md), [data-model.md](./data-model.md), [contracts/](./contracts/)

Expand All @@ -27,7 +27,7 @@ description: "Task list for spec 027: contributor docs and layout map"
## Phase 1: Setup

- [X] T001 Create branch `claude/027-contributor-docs` in GP from latest `master` (after the spec docs PR merges) and `claude/027-contributing-pointer` in WEB from latest `main` (done on `claude/project-thread-y09b3k` in both repos, the thread branch)
- [X] T002 Re-measure on the new `master` the facts the docs will state (research R1–R4: symlink modes, `AGENT.md` references, `specs.md` count, module shapes, largest web files) and record the SHA and any drift at the top of `specs/027-contributor-docs-layout-map/research.md`
- [X] T002 Re-measure on the new `master` the facts the docs will state (research R1–R4: symlink modes, `AGENT.md` references, `specs.md` count, module shapes, largest web files) and record the SHA and any drift at the top of `specs/done_027-contributor-docs-layout-map/research.md`

---

Expand Down Expand Up @@ -99,9 +99,9 @@ description: "Task list for spec 027: contributor docs and layout map"
## Phase 7: Review and delivery

- [X] T022 Tier-up review (`sonnet`) of the combined GP and WEB diffs against spec FR-001..FR-020 and this task list; fixes go to a new `haiku` fix wave
- [ ] T023 Push both branches; open WEB PR (`type: docs`) and GP PR (`type: docs`, `area: specs`, `area: shared`); check CI green and every CodeRabbit finding fixed or settled before calling either ready
- [ ] T024 After the WEB PR merges: bump the `website` submodule pointer in GP (`chore: bump website submodule`) in its own PR
- [ ] T025 After every PR merges: mark tasks `[X]`, `git mv specs/027-contributor-docs-layout-map specs/done_027-contributor-docs-layout-map` and update references in the same commit (rule 16); tell spec 028 that `docs/layout.md` is on `master`
- [X] T023 Push both branches; open WEB PR (`type: docs`) and GP PR (`type: docs`, `area: specs`, `area: shared`); check CI green and every CodeRabbit finding fixed or settled before calling either ready
- [X] T024 After the WEB PR merges: bump the `website` submodule pointer in GP (`chore: bump website submodule`) in its own PR
- [X] T025 After every PR merges: mark tasks `[X]`, `git mv specs/027-contributor-docs-layout-map specs/done_027-contributor-docs-layout-map` and update references in the same commit (rule 16); tell spec 028 that `docs/layout.md` is on `master`
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved

---

Expand Down
2 changes: 1 addition & 1 deletion website
Loading