Documentation
¶
Overview ¶
Package agentguide holds the curated order of the user-facing guide sections shipped by `tkn-act agent-guide`. Both the generator (internal/agentguide-gen) and the embedding command (agentguide.go) import this list so the two cannot drift.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Order = []string{
"overview",
"docker-backend",
"step-template",
"sidecars",
"step-actions",
"matrix",
"pipeline-results",
"display-name",
"timeouts",
"resolvers",
}
Order is the curated concatenation order for the user-guide files under docs/agent-guide/. Each entry is the base name without the `.md` suffix; "overview" is the alias for README.md.
When concatenated into the default `tkn-act agent-guide` output, adjacent files are separated by a horizontal-rule block ("---") matching the existing in-section separators in the source files.
Functions ¶
func FileName ¶
FileName returns the on-disk file name for a section in Order. The alias "overview" maps to README.md; every other section maps to `<section>.md`.
func Generate ¶
Generate mirrors the user-guide files under src into dst, in canonical form: each destination file holds exactly the source's content trimmed to one trailing newline. Source files are validated against Order — every entry must be present, and no extra .md files may exist alongside.
Any non-canonical entry already living under dst (stale .md files from a rename, non-markdown leftovers, subdirectories) is removed, so a clean regenerate produces a tree that mirrors Order exactly.
Generate is the single implementation shared by `agentguide-gen` (the generator binary invoked from `go generate ./cmd/tkn-act/`) and the freshness test under cmd/tkn-act/, so the two cannot drift in behavior.
Types ¶
This section is empty.
Source Files