Skip to content

docs: observability.md describes unimplemented commands without a clear notice #954

Description

@codeforester

The document describes basectl history, basectl explain last-error, and basectl report with detailed schemas, output formats, and flags. None of these commands exist in the current Base 1.1.0 release. The only signal that these are future designs is the phrase "It is a design contract for future implementation" in the introduction, which is easy to miss, and the "Future Commands" section heading. A user or onboarder reading this alongside command-reference.md will be confused when these commands are absent.

Fix: Add a prominent notice at the very top — ideally a callout block — stating:

DESIGN DOC — These commands are not yet implemented as of Base 1.1.0. Use basectl logs for current log access.

File: docs/observability.md

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

No type
No fields configured for issues without a type.

Projects

Status
Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions