Skip to content

docs: add package comments for runtime and templates #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
julianknutsen wants to merge 2 commits into from
Closed

docs: add package comments for runtime and templates #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2b1bb6
docs: add inline comment explaining //go:embed directives (gt-e6e0q)
Jan 19, 2026
0dfa143
docs: expand package comment in internal/runtime (gt-va49s)
Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion internal/runtime/runtime.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
// Package runtime provides helpers for runtime-specific integration.
// Package runtime provides helpers for runtime-specific integration across
// different LLM agent backends (Claude, OpenCode). It handles session ID
// detection, hook installation, startup fallback commands for environments
// without native hooks, and role-specific behavior configuration for
// autonomous vs human-guided agent roles.
package runtime

import (
Expand Down
6 changes: 6 additions & 0 deletions internal/templates/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ import (
"text/template"
)

// The //go:embed directives below use Go's embed package to include template files
// directly in the compiled binary. At compile time, the Go toolchain reads matching
// files from disk and embeds their contents into the embed.FS variable. This allows
// the templates to be distributed as a single binary without external file dependencies.
// The glob patterns (e.g., "roles/*.md.tmpl") specify which files to embed.

//go:embed roles/*.md.tmpl messages/*.md.tmpl
var templateFS embed.FS

Expand Down
Loading