docs: add some package-level GoDoc comments

Christian Rocha and Justin Johnson created 1 month ago

Co-authored-by: Justin Johnson <[e-mail]>

Change summary

CRUSH.md                | 2 +-
internal/agent/agent.go | 9 ++++++++-
internal/app/app.go     | 2 ++
3 files changed, 11 insertions(+), 2 deletions(-)

Detailed changes

CRUSH.md

@@ -62,7 +62,7 @@ func TestYourFunction(t *testing.T) {
 
 ## Comments
 
-- Comments that live one their own lines should start with capital letters and
+- Comments that live on their own lines should start with capital letters and
   end with periods. Wrap comments at 78 columns.
 
 ## Committing

internal/agent/agent.go

@@ -1,3 +1,10 @@
+// Package agent is the core orchestration layer for Crush AI agents.
+//
+// It provides session-based AI agent functionality for managing
+// conversations, tool execution, and message handling. It coordinates
+// interactions between language models, messages, sessions, and tools while
+// handling features like automatic summarization, queuing, and token
+// management.
 package agent
 
 import (
@@ -131,7 +138,7 @@ func (a *sessionAgent) Run(ctx context.Context, call SessionAgentCall) (*fantasy
 	}
 
 	if len(a.tools) > 0 {
-		// Add anthropic caching to the last tool.
+		// Add Anthropic caching to the last tool.
 		a.tools[len(a.tools)-1].SetProviderOptions(a.getCacheControlOptions())
 	}
 

internal/app/app.go

@@ -1,3 +1,5 @@
+// Package app wires together services, coordinates agents, and manages
+// application lifecycle.
 package app
 
 import (