site: step reference pages don't exist; CLI surface undocumented
CLAUDE.md and CONTRIBUTING.md both mandate step reference pages under
site/content/docs/steps/. That directory does not exist; site content
is 5 files total. The only field-level step docs are the CLI-embedded
ones (scampi index <step>, generated from struct tags) - and scampi index itself is documented nowhere.
What exists on the site is accurate (every published code sample runs
clean against the current binary; transcripts match renderer output),
so this is a coverage problem, not a correctness one.
Gaps
- No step reference pages for any of the 15 kinds.
- Undocumented commands:
index, inspect, secrets, fmt,
version (test is described conceptually but never shown).
- Undocumented flags:
--ascii, --color, --only, --targets.
posix.source_remote/posix.source_target and ssh.target's
optional fields (port, key, insecure, timeout,
max_sessions) never mentioned.
internal/std/container/container.scampi:28 declares
image: string = "" (effectively optional) but the Go config tags it
as required (internal/step/container/container.go:74). Pick one.
Fix
site: step reference pages don't exist; CLI surface undocumented
CLAUDE.md and CONTRIBUTING.md both mandate step reference pages under
site/content/docs/steps/. That directory does not exist; site contentis 5 files total. The only field-level step docs are the CLI-embedded
ones (
scampi index <step>, generated from struct tags) - andscampi indexitself is documented nowhere.What exists on the site is accurate (every published code sample runs
clean against the current binary; transcripts match renderer output),
so this is a coverage problem, not a correctness one.
Gaps
index,inspect,secrets,fmt,version(testis described conceptually but never shown).--ascii,--color,--only,--targets.posix.source_remote/posix.source_targetandssh.target'soptional fields (
port,key,insecure,timeout,max_sessions) never mentioned.internal/std/container/container.scampi:28declaresimage: string = ""(effectively optional) but the Go config tags itas required (
internal/step/container/container.go:74). Pick one.Fix
site/content/docs/steps/from the same source asscampi index(struct tags viaengine.IndexAll), so the pagescan't drift. One page per kind.
the CLAUDE.md mandate).
imageoptionality mismatch.