Skip to content

🤖 fix: refresh AGENTS.md to match current repo#16

Merged
ThomasK33 merged 1 commit into
mainfrom
docs/update-agents-md
Feb 9, 2026
Merged

🤖 fix: refresh AGENTS.md to match current repo#16
ThomasK33 merged 1 commit into
mainfrom
docs/update-agents-md

Conversation

@ThomasK33

Copy link
Copy Markdown
Member

Summary

Refresh AGENTS.md so it accurately documents the current coder-k8s architecture, tooling, commands, and contribution workflow.

Background

AGENTS.md had drifted from the repository state (Go version, architecture scope, command set, and key paths). This update aligns contributor/agent guidance with the actual codebase to reduce onboarding and execution errors.

Implementation

  • Updated project overview to describe both app modes (controller and aggregated-apiserver).
  • Corrected tech stack details (Go 1.25.7, inclusion of apiserver, golangci-lint/gofumpt, and scripts/).
  • Expanded key files and important directories to include:
    • dispatch/bootstrap packages (app_dispatch.go, internal/app/...)
    • aggregated API types/storage (api/aggregation/..., internal/aggregated/...)
    • manifest/deploy/release/lint assets (config/, deploy/, .golangci.yml, .goreleaser.yaml, Dockerfile.goreleaser, release.yaml)
  • Updated architecture notes for required --app dispatch and aggregated API installation.
  • Refreshed essential commands to match Makefile/linting workflow (make lint, make manifests, make vuln, mode-specific run commands, golangci-lint fmt).
  • Updated patterns/checklists to include generated-manifest flow and broader test expectations.
  • Added Uber Go style guide as baseline guidance while preserving project-specific conventions.

Validation

  • make verify-vendor
  • make test
  • make build
  • make lint

Risks

Low risk (documentation-only). Main regression risk is stale guidance over time; this change reduces that by aligning docs with current repository structure.


Generated with mux • Model: openai:gpt-5.3-codex • Thinking: xhigh • Cost: $0.34

Update AGENTS.md to reflect the current dual-mode architecture, tooling, commands, and repository layout.

---

_Generated with `mux` • Model: `openai:gpt-5.3-codex` • Thinking: `xhigh` • Cost: `$0.34`_

<!-- mux-attribution: model=openai:gpt-5.3-codex thinking=xhigh costs=0.34 -->
@ThomasK33

Copy link
Copy Markdown
Member Author

@codex review

Please review this documentation refresh for AGENTS.md and confirm readiness.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🎉

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@ThomasK33 ThomasK33 added this pull request to the merge queue Feb 9, 2026
@ThomasK33

Copy link
Copy Markdown
Member Author

Merged via the queue into main with commit 3c191c5 Feb 9, 2026
7 checks passed
@ThomasK33 ThomasK33 deleted the docs/update-agents-md branch February 9, 2026 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant