docs(activity): add package-level godoc to internal/activity #336

Merged

fuzzy merged 1 commit from docs/285-activity-package-godoc into main

2026-07-08 04:58:32 +00:00

automation commented

2026-07-08 04:43:56 +00:00

Owner

What

Add a comprehensive package-level godoc comment to internal/activity/types.go describing the package's purpose, organization, and architecture.

Covers:

SQLite-backed local cache
TTL-based staleness with per-date immutability
Paginated Forgejo API fetching and event aggregation
Bar graph and legacy sparkline rendering
View coordinator tying everything together

Why

Go convention requires every package to have a doc comment. This helps anyone reading the code understand the package's scope at a glance.

Testing

go build passes
go test -race -short ./... passes
golangci-lint passes

Closes #285

## What Add a comprehensive package-level godoc comment to `internal/activity/types.go` describing the package's purpose, organization, and architecture. Covers: - SQLite-backed local cache - TTL-based staleness with per-date immutability - Paginated Forgejo API fetching and event aggregation - Bar graph and legacy sparkline rendering - View coordinator tying everything together ## Why Go convention requires every package to have a doc comment. This helps anyone reading the code understand the package's scope at a glance. ## Testing - [x] `go build` passes - [x] `go test -race -short ./...` passes - [x] golangci-lint passes Closes #285

automation added 1 commit

2026-07-08 04:43:56 +00:00

docs(activity): add package-level godoc to internal/activity

Test and Release / lint (pull_request) Successful in 29s

Details

Test and Release / test (pull_request) Successful in 30s

Details

9b9d9fcb12

Add a comprehensive package doc comment describing the package purpose,
organization, and key files. Covers the SQLite cache, staleness TTL,
Forgejo API fetching, rendering pipeline, and view coordinator.

the.auditor approved these changes

2026-07-08 04:47:57 +00:00

the.auditor left a comment

Review

Result: Approved — no issues. Closes #285.

14-line package godoc added to internal/activity/types.go. Covers purpose, 30-day window, and per-file breakdown. No functional change.

## Review **Result: Approved** — no issues. Closes #285. 14-line package godoc added to `internal/activity/types.go`. Covers purpose, 30-day window, and per-file breakdown. No functional change.

fuzzy added this to the Steeper project

2026-07-08 04:57:38 +00:00

fuzzy self-assigned this

2026-07-08 04:57:40 +00:00

fuzzy merged commit 9b9d9fcb12 into main

2026-07-08 04:58:32 +00:00

fuzzy deleted branch docs/285-activity-package-godoc

2026-07-08 04:58:32 +00:00