docs

Documentation

Overview

Package docs generates GSKILL's reference documentation from the live sources of truth — the Kong command grammar (internal/cli) and the exit-code table (internal/errs) — so the reference can never silently drift from the tool.

The rendered Markdown is deterministic (sorted, timestamp-free) so it is safe to commit and golden-test. Regenerate with: go run ./cmd/gen-reference

Index

• Constants
• func RenderAll() (map[string]string, error)
• func RenderCommands(model *kong.Application) string
• func RenderExitCodes() string

Constants

const (
	CommandsPath  = "docs/reference/commands.md"
	ExitCodesPath = "docs/reference/exit-codes.md"
)

CommandsPath and ExitCodesPath are the repo-relative targets the generator writes.

Functions

func RenderAll

func RenderAll() (map[string]string, error)

RenderAll renders both reference documents, returning them keyed by repo path.

func RenderCommands

func RenderCommands(model *kong.Application) string

RenderCommands builds the Markdown command reference from the Kong model. Output is deterministic: global flags first, then commands sorted by name, each with its flags sorted by name.

func RenderExitCodes

func RenderExitCodes() string

RenderExitCodes builds the Markdown exit-code reference from the errs table. Codes are emitted in numeric order; their numbers come from internal/errs so they cannot diverge from the tool's actual contract.