Skip to content

docs/command-reference.md: stray diff artifact broke a heading + missing basectl logs entry #2061

Description

@codeforester

Problem

Two issues in docs/command-reference.md, both introduced or exposed by the recent restructuring that moved the full command reference out of README.md into this file (commit 7cb41c1, #2021):

1. Line 260 -- a literal diff artifact broke a heading. Immediately after the real ## Detailed Product Layers And Shipped Commands heading (line 258), line 260 reads:

+## Product Layers And Shipped Commands

The leading + is not valid Markdown heading syntax (a stray character left over from a diff/patch application), so it renders as plain text directly below the real heading -- a visibly broken, duplicate-looking section title right at the top of the file's main reference section.

2. The top-level command inventory is missing basectl logs. docs/command-reference.md's "Current implemented commands include" list (lines 277-317) -- mirrored in README.md's own command inventory (lines 341-368) -- omits basectl logs, even though logs (with last-failed, --latest, --open, --tail) is a real, actively-documented top-level command shown in basectl --help's "Diagnostics and maintenance" section, and command-reference.md's own "Diagnostics And Logs" table (line 189) already documents it in detail. The summary list just never lists the command itself.

Why this matters

The first is a visible rendering bug in the file's main reference section, right where a new restructuring should have been reviewed most carefully. The second means a reader scanning the top-level command list for orientation won't discover basectl logs exists at all, despite it being fully documented elsewhere in the same file.

Proposed change

  • Delete the stray +## Product Layers And Shipped Commands line.
  • Add basectl logs [--latest|--open|--tail|last-failed] (or similar) to both the command-reference.md inventory list and README.md's mirrored list.

Acceptance criteria

  • The stray + heading artifact is removed.
  • basectl logs appears in both command inventory lists.

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

No type

Projects

  • Status
    In Progress

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions