Skip to content

site: step reference pages don't exist; CLI surface undocumented #447

Description

@pskry

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

  • Generate site/content/docs/steps/ from the same source as
    scampi index (struct tags via engine.IndexAll), so the pages
    can't drift. One page per kind.
  • Rules invariant: every registered kind has a site page (mirrors
    the CLAUDE.md mandate).
  • Document the CLI surface: commands + global flags.
  • Resolve the container image optionality mismatch.
  • Document target optional fields.

Metadata

Metadata

Assignees

No one assigned

    Labels

    impact/highChanges what the tool can do, unlocks new use caseskind/documentationDocumentation changespriority/mediumThe priority is medium

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions