Skip to content

docs(repo): document code architecture#37

Merged
fdatoo merged 3 commits into
mainfrom
codex/code-documentation
May 16, 2026
Merged

docs(repo): document code architecture#37
fdatoo merged 3 commits into
mainfrom
codex/code-documentation

Conversation

@fdatoo
Copy link
Copy Markdown
Owner

@fdatoo fdatoo commented May 16, 2026

Summary

  • add package-level docs for undocumented Go packages
  • add contract comments for core API/auth/eventstore/observability surfaces
  • add a contributor repository architecture and layout guide, linked from the docs nav

Validation

  • task fmt-check
  • task lint
  • go test ./internal/api/... ./internal/auth/... ./internal/automation/scene ./internal/carport/fakedriver ./internal/eventstore ./internal/observability ./internal/pkllsp ./internal/storage ./internal/starlark/... ./internal/testutil
  • go test ./internal/api/... ./internal/auth/... ./internal/eventstore ./internal/observability ./internal/pkllsp ./internal/storage ./internal/web
  • pre-push hook: go test ./..., go test -race ./..., go test -tags=integration ./...

Note: docs build was not run locally because zensical is not installed in this environment.

@fdatoo fdatoo marked this pull request as ready for review May 16, 2026 09:26
@fdatoo fdatoo merged commit 24bf441 into main May 16, 2026
18 checks passed
@fdatoo fdatoo deleted the codex/code-documentation branch May 16, 2026 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant