clidocs

Documentation

Overview

Package clidocs is the small helper that renders the dockyard CLI command tree as a Markdown page for the published documentation site (Phase 29 — docs/site/cli/index.md).

Why a helper instead of hand-written CLI docs: the cobra command tree already carries every verb's Long help, flag list, and short description. A hand-maintained CLI reference would drift the first time a flag was added without a docs update. The helper walks the command tree once at docs-build time and produces a deterministic Markdown page — same source of truth, no drift.

The package exposes one function (Render) and a small cmd/ binary (cmd/clidocs) that the Makefile invokes from `make docs`.

Index

• func Render(w io.Writer) error

Functions

func Render

func Render(w io.Writer) error

Render writes the dockyard CLI command tree as a Markdown page to w.

The page leads with the root command's Long, then renders each subcommand in alphabetical order with its Use, Short, Long and flag table. The output is deterministic — given the same command tree, Render produces byte-identical bytes — so `make docs` only updates the page when the CLI surface actually changed.