Add package-level docs across internal packages

20 files changed, 40 insertions, 0 deletions

diff --git a/internal/benchutil/doc.go b/internal/benchutil/doc.go
new file mode 100644
index 0000000..eec2017
--- /dev/null
+++ b/internal/benchutil/doc.go
@@ -0,0 +1,2 @@
+// Package benchutil provides fixtures and helpers used by benchmark suites.
+package benchutil
diff --git a/internal/doc.go b/internal/doc.go
new file mode 100644
index 0000000..adf259b
--- /dev/null
+++ b/internal/doc.go
@@ -0,0 +1,2 @@
+// Package internal contains runtime orchestration helpers shared by command entrypoints.
+package internal
diff --git a/internal/event/doc.go b/internal/event/doc.go
new file mode 100644
index 0000000..1504e6f
--- /dev/null
+++ b/internal/event/doc.go
@@ -0,0 +1,2 @@
+// Package event decodes and formats kernel event payloads for downstream consumers.
+package event
diff --git a/internal/file/doc.go b/internal/file/doc.go
new file mode 100644
index 0000000..dd3c2dd
--- /dev/null
+++ b/internal/file/doc.go
@@ -0,0 +1,2 @@
+// Package file provides file metadata helpers used by trace rendering and export code.
+package file
diff --git a/internal/flags/doc.go b/internal/flags/doc.go
new file mode 100644
index 0000000..103b6d4
--- /dev/null
+++ b/internal/flags/doc.go
@@ -0,0 +1,2 @@
+// Package flags parses CLI options and exposes runtime configuration snapshots.
+package flags
diff --git a/internal/flamegraph/doc.go b/internal/flamegraph/doc.go
new file mode 100644
index 0000000..8ff27d2
--- /dev/null
+++ b/internal/flamegraph/doc.go
@@ -0,0 +1,2 @@
+// Package flamegraph builds aggregated call trees and rendering inputs for I/O flamegraphs.
+package flamegraph
diff --git a/internal/generate/doc.go b/internal/generate/doc.go
new file mode 100644
index 0000000..4a02b7b
--- /dev/null
+++ b/internal/generate/doc.go
@@ -0,0 +1,2 @@
+// Package generate contains code-generation logic for tracepoint handlers and Go types.
+package generate
diff --git a/internal/probemanager/doc.go b/internal/probemanager/doc.go
new file mode 100644
index 0000000..dd940b4
--- /dev/null
+++ b/internal/probemanager/doc.go
@@ -0,0 +1,2 @@
+// Package probemanager tracks probe enablement state and runtime toggling operations.
+package probemanager
diff --git a/internal/statsengine/doc.go b/internal/statsengine/doc.go
new file mode 100644
index 0000000..2d2c0c0
--- /dev/null
+++ b/internal/statsengine/doc.go
@@ -0,0 +1,2 @@
+// Package statsengine aggregates trace events into dashboard snapshot statistics.
+package statsengine
diff --git a/internal/tracepoints/doc.go b/internal/tracepoints/doc.go
new file mode 100644
index 0000000..8cd0d1f
--- /dev/null
+++ b/internal/tracepoints/doc.go
@@ -0,0 +1,2 @@
+// Package tracepoints exposes generated syscall tracepoint metadata.
+package tracepoints
diff --git a/internal/tui/common/doc.go b/internal/tui/common/doc.go
new file mode 100644
index 0000000..e15ceb7
--- /dev/null
+++ b/internal/tui/common/doc.go
@@ -0,0 +1,2 @@
+// Package common provides shared TUI styling, keymaps, and viewport utilities.
+package common
diff --git a/internal/tui/dashboard/doc.go b/internal/tui/dashboard/doc.go
new file mode 100644
index 0000000..b9bc30e
--- /dev/null
+++ b/internal/tui/dashboard/doc.go
@@ -0,0 +1,2 @@
+// Package dashboard implements the multi-tab runtime dashboard used in TUI mode.
+package dashboard
diff --git a/internal/tui/doc.go b/internal/tui/doc.go
new file mode 100644
index 0000000..3175d65
--- /dev/null
+++ b/internal/tui/doc.go
@@ -0,0 +1,2 @@
+// Package tui hosts the top-level terminal UI model and screen routing.
+package tui
diff --git a/internal/tui/eventstream/doc.go b/internal/tui/eventstream/doc.go
new file mode 100644
index 0000000..38bc854
--- /dev/null
+++ b/internal/tui/eventstream/doc.go
@@ -0,0 +1,2 @@
+// Package eventstream renders live event rows and interactive filtering controls.
+package eventstream
diff --git a/internal/tui/export/doc.go b/internal/tui/export/doc.go
new file mode 100644
index 0000000..356b800
--- /dev/null
+++ b/internal/tui/export/doc.go
@@ -0,0 +1,2 @@
+// Package export implements the TUI snapshot export modal and option handling.
+package export
diff --git a/internal/tui/flamegraph/doc.go b/internal/tui/flamegraph/doc.go
new file mode 100644
index 0000000..7982ae9
--- /dev/null
+++ b/internal/tui/flamegraph/doc.go
@@ -0,0 +1,2 @@
+// Package flamegraph renders the interactive terminal flamegraph dashboard tab.
+package flamegraph
diff --git a/internal/tui/messages/doc.go b/internal/tui/messages/doc.go
new file mode 100644
index 0000000..8d70859
--- /dev/null
+++ b/internal/tui/messages/doc.go
@@ -0,0 +1,2 @@
+// Package messages defines typed Bubble Tea messages exchanged across TUI models.
+package messages
diff --git a/internal/tui/pidpicker/doc.go b/internal/tui/pidpicker/doc.go
new file mode 100644
index 0000000..5f863c0
--- /dev/null
+++ b/internal/tui/pidpicker/doc.go
@@ -0,0 +1,2 @@
+// Package pidpicker implements PID and TID selection workflows before tracing starts.
+package pidpicker
diff --git a/internal/tui/probes/doc.go b/internal/tui/probes/doc.go
new file mode 100644
index 0000000..922aee6
--- /dev/null
+++ b/internal/tui/probes/doc.go
@@ -0,0 +1,2 @@
+// Package probes implements the runtime probe toggling modal for the TUI.
+package probes
diff --git a/internal/types/doc.go b/internal/types/doc.go
new file mode 100644
index 0000000..79f156e
--- /dev/null
+++ b/internal/types/doc.go
@@ -0,0 +1,2 @@
+// Package types provides generated Go structs mirroring BPF event payload layouts.
+package types