[Control Plane] Add godoc to storage interface methods

[santoshkumarradha]

Summary

The storage interface in the control plane defines 50+ methods but lacks godoc documentation. Adding documentation will help contributors understand the storage abstraction layer.

Current State

• File: control-plane/internal/storage/storage.go
• Methods: 50+ interface methods
• Documentation: Minimal to none

Tasks

Add godoc comments to all interface methods explaining:

1. What the method does
2. Parameters and their expected values
3. Return values and possible errors
4. Any important behavior notes (e.g., transaction semantics)

Example Format

// GetExecution retrieves an execution record by its unique identifier.
// Returns the execution if found, or an error if not found or on database failure.
//
// Parameters:
//   - ctx: Context for cancellation and timeout
//   - id: Unique execution identifier (UUID format)
//
// Returns ErrNotFound if the execution does not exist.
GetExecution(ctx context.Context, id string) (*Execution, error)

Priority Methods to Document

Start with these commonly-used methods:

• GetExecution / CreateExecution / UpdateExecution
• GetAgent / RegisterAgent / UpdateAgentStatus
• GetMemory / SetMemory / DeleteMemory
• GetWorkflow / CreateWorkflow

Acceptance Criteria

• All public interface methods have godoc comments
• Documentation follows Go conventions
• go doc output is clear and helpful
• Code compiles without errors

Files

• control-plane/internal/storage/storage.go

---

Using AI to solve this issue? Read our AI-Assisted Contributions guide for testing requirements, prompt strategies, and common pitfalls to avoid.