Skip to content

devlore-docs generates pages for lore and writ only; star and devlore-test have no CLI reference #787

Closed

Description

@David-Noble-at-work

Feature: #834 — Help and reference: wrapped help, generated CLI docs, the specification

cmd/devlore-docs builds the command trees of writ and lore and generates docs/cli/** for those two.
star and devlore-test are in scope for the convention (10-command-line-interface.md §2) and on the
shared root since #743 and #776, and neither has a generated reference: make docs says nothing about them,
and the published site carries nothing about them.

Star's root lives in package main (cmd/star), so the generator cannot import it the way it imports
lore.NewRootCmd and writ.NewRootCmd; that is the one design question. devlore-test's root is importable
today.

Acceptance

  • make docs generates docs/cli/star/** and docs/cli/devlore-test/**
  • the docs-publish workflow copies them with the rest
  • a test asserts every in-scope program has a generated tree

Found closing #776. Its own worktree.

Ticked 2026-09-21. The design question answered by ruling: star's root is an importable package, cmd/star/star
(package star, NewRootCmd), like cmd/writ/writ; the extension host that held that name is cmd/star/extension;
the bundled extensions' embed is cmd/star/extensions (bundled.FS). devlore-docs walks the four roots -- star's
with its extensions, so docs/cli/star/gh/issues/report.md exists -- and TestRun_EveryProgramHasATree names the
four. make build runs the generator after the tools (ruled 2026-09-21), so a checkout that built has a current
docs/cli/; docs-publish.yaml copies docs/cli/ whole, so the two new trees publish by construction. §12 says so.
Plan: docs/plans/fix/787-cli-reference.md.

Metadata

Metadata

Labels

Area:CLICommand-line interfaceEpic:CommandLineOne output convention across every CLI in the suitePriority:P3Someday, or on next contactSeverity:LowCosmetic, or a defect nobody is hittingbugSomething isn't working

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions