Skip to content

docs: update go/README.md to reflect single-module structure #1715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EItanya merged 2 commits into from
Apr 20, 2026
+6 −6
Merged

docs: update go/README.md to reflect single-module structure #1715

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f6591f
docs: update go/README.md to reflect single-module structure
mesutoezdil Apr 20, 2026
2e74da6
Apply suggestions from code review
EItanya Apr 20, 2026
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
12 changes: 6 additions & 6 deletions go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Kagent Go Workspace
# Kagent Go

This directory is a [Go workspace](https://go.dev/doc/tutorial/workspaces) (`go.work`) containing three modules that make up the Go components of Kagent.
This directory is a single Go module (`github.com/kagent-dev/kagent/go`) containing three top-level package trees that make up the Go components of Kagent.

## Modules
## Packages

| Module | Path | Description |
|--------|------|-------------|
| Package | Path | Description |
|---------|------|-------------|
| **api** | `go/api/` | Shared types: CRD definitions, ADK model types, database models, HTTP client SDK |
| **core** | `go/core/` | Infrastructure: Kubernetes controllers, HTTP server, CLI, database implementation |
| **adk** | `go/adk/` | Go Agent Development Kit for building and running agents |
Comment on lines +7 to 11
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section labels api, core, and adk as “Package” and uses paths like go/api/, which aren’t actual Go import paths and may be read as single-package directories. To reduce confusion, consider renaming the column to “Directory/Component” (or similar) and/or adjusting paths to match the directory tree below (api/, core/, adk/) or providing example import paths under the module (github.com/kagent-dev/kagent/go/api/...).

Copilot uses AI. Check for mistakes.
Expand All @@ -23,7 +23,7 @@ go/core go/adk

```
go/
├── go.work # Go workspace file
├── go.mod # Single Go module file
├── Makefile # Unified build targets
├── Dockerfile # Shared multi-stage Docker build
│
Expand Down