docs: add trivial documentation for all types, functions, packages etc.

internal/config/config.go

@@ -8,14 +8,23 @@ import (
 	"resty.dev/v3"
 )
 
+// Config holds the application's configuration.
 type Config struct {
-	Ctx                 context.Context
-	CancelFunc          context.CancelFunc
-	KV                  *redis.Client
-	Client              *resty.Client
-	IsDevelopment       bool
-	BaseURL             string
-	Environment         string
+	// Ctx is the application's root context.
+	Ctx context.Context
+	// CancelFunc cancels the application's root context.
+	CancelFunc context.CancelFunc
+	// KV provides access to the Redis cache.
+	KV *redis.Client
+	// Client is the HTTP client for making API requests.
+	Client *resty.Client
+	// IsDevelopment is true if the application is running in a development environment.
+	IsDevelopment bool
+	// BaseURL is the base URL for the Banner API.
+	BaseURL string
+	// Environment is the application's running environment (e.g. "development").
+	Environment string
+	// CentralTimeLocation is the time.Location for US Central Time.
 	CentralTimeLocation *time.Location
 }
 
@@ -23,10 +32,11 @@ const (
 	CentralTimezoneName = "America/Chicago"
 )
 
+// New creates a new Config instance with a cancellable context.
 func New() (*Config, error) {
 	ctx, cancel := context.WithCancel(context.Background())
 
-	loc, err := time.LoadLocation(CentralTimezoneName)
+	loc, err := time.LoadLocation("America/Chicago")
 	if err != nil {
 		cancel()
 		return nil, err
@@ -39,23 +49,23 @@ func New() (*Config, error) {
 	}, nil
 }
 
-// SetBaseURL sets the base URL for API requests
+// SetBaseURL sets the base URL for the Banner API.
 func (c *Config) SetBaseURL(url string) {
 	c.BaseURL = url
 }
 
-// SetEnvironment sets the environment
+// SetEnvironment sets the application's environment.
 func (c *Config) SetEnvironment(env string) {
 	c.Environment = env
 	c.IsDevelopment = env == "development"
 }
 
-// SetClient sets the Resty client
+// SetClient sets the Resty client for making HTTP requests.
 func (c *Config) SetClient(client *resty.Client) {
 	c.Client = client
 }
 
-// SetRedis sets the Redis client
+// SetRedis sets the Redis client for caching.
 func (c *Config) SetRedis(r *redis.Client) {
 	c.KV = r
 }

internal/config/logging.go

@@ -1,3 +1,4 @@
+// Package config provides the configuration and logging setup for the application.
 package config
 
 import (
@@ -9,12 +10,7 @@ import (
 
 const timeFormat = "2006-01-02 15:04:05"
 
-var (
-	stdConsole = zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: timeFormat}
-	errConsole = zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: timeFormat}
-)
-
-// NewConsoleWriter creates a new console writer with improved formatting for development
+// NewConsoleWriter creates a new console writer that splits logs between stdout and stderr.
 func NewConsoleWriter() zerolog.LevelWriter {
 	return &ConsoleLogSplitter{
 		stdConsole: zerolog.ConsoleWriter{
@@ -36,18 +32,18 @@ func NewConsoleWriter() zerolog.LevelWriter {
 	}
 }
 
-// ConsoleLogSplitter implements zerolog.LevelWriter with console formatting
+// ConsoleLogSplitter is a zerolog.LevelWriter that writes to stdout for info/debug logs and stderr for warn/error logs, with console-friendly formatting.
 type ConsoleLogSplitter struct {
 	stdConsole zerolog.ConsoleWriter
 	errConsole zerolog.ConsoleWriter
 }
 
-// Write should not be called
+// Write is a passthrough to the standard console writer and should not be called directly.
 func (c *ConsoleLogSplitter) Write(p []byte) (n int, err error) {
 	return c.stdConsole.Write(p)
 }
 
-// WriteLevel write to the appropriate output with console formatting
+// WriteLevel writes to the appropriate output (stdout or stderr) with console formatting based on the log level.
 func (c *ConsoleLogSplitter) WriteLevel(level zerolog.Level, p []byte) (n int, err error) {
 	if level <= zerolog.WarnLevel {
 		return c.stdConsole.Write(p)
@@ -55,22 +51,21 @@ func (c *ConsoleLogSplitter) WriteLevel(level zerolog.Level, p []byte) (n int, e
 	return c.errConsole.Write(p)
 }
 
-// LogSplitter implements zerolog.LevelWriter
+// LogSplitter is a zerolog.LevelWriter that writes to stdout for info/debug logs and stderr for warn/error logs.
 type LogSplitter struct {
 	Std io.Writer
 	Err io.Writer
 }
 
-// Write should not be called
+// Write is a passthrough to the standard writer and should not be called directly.
 func (l LogSplitter) Write(p []byte) (n int, err error) {
 	return l.Std.Write(p)
 }
 
-// WriteLevel write to the appropriate output
+// WriteLevel writes to the appropriate output (stdout or stderr) based on the log level.
 func (l LogSplitter) WriteLevel(level zerolog.Level, p []byte) (n int, err error) {
 	if level <= zerolog.WarnLevel {
 		return l.Std.Write(p)
-	} else {
-		return l.Err.Write(p)
 	}
+	return l.Err.Write(p)
 }