Skip to content

docs: CLI navigation map (single source of truth) - #243

Merged
aptracebloc merged 2 commits into
developfrom
docs/cli-navigation-map
Jul 13, 2026
Merged

docs: CLI navigation map (single source of truth)#243
aptracebloc merged 2 commits into
developfrom
docs/cli-navigation-map

Conversation

@LukasWodka

@LukasWodkaLukasWodka commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

What

Adds docs/cli-navigation.mdthe single source of truth for how a user moves through the CLI. Four Mermaid flowcharts (top-level map · the two gate chains · data ingest · resources) + an exit-code legend + cross-links + a "known gaps" section. Renders natively in the Files tab; it's text, so it's diffable and stays live via PRs (this PR is where we discuss flow changes).

Why

As the CLI grows we need one canonical, viewable, discussable picture of every path and where a user can end up — not a drawing in a tool nobody can diff.

Notable structural facts it surfaced (worth the team's eyes)

Docs-only; no code change.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only change with no runtime or code behavior impact.

Overview
Introduces docs/cli-navigation.md as the version-controlled, PR-reviewable map of how users move through tracebloc / tb: four Mermaid flowcharts plus exit-code table, recovery cross-links, and a known gaps section.

The top-level map groups account vs secure-environment commands, aliases, and hidden/back-compat routes. Chain A vs Chain B documents that account commands require a user token while data/environment commands use kubeconfig + in-cluster token without sign-in. Dedicated diagrams cover data ingest (wizard vs flags, local checks, staging, outcomes) and resources (show solid on develop; set and the status-aware home screen drawn dashed as not shipped / proposed).

The doc pins basis to develop @ 27c5392 and calls out review topics (e.g. offboard always exit 0, non-monotonic ingest exit codes).

Reviewed by Cursor Bugbot for commit 2bea591. Bugbot is set up for automated code reviews on this repo. Configure here.

aptracebloc
aptracebloc previously approved these changes Jul 13, 2026
LukasWodkaand others added 2 commits July 13, 2026 11:26
Four Mermaid flowcharts (top-level, the two gate chains, data ingest, resources)
+ exit-code legend + cross-links + known gaps. Diffable, renders on GitHub, kept
current via PRs. Flags: two independent gate chains; stateless home today (status
redesign proposed); delete exits 0 on partial offboard; resources unshipped.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
#237 put `resources show` on develop, so un-dash SHOW (keep `set`/#241
dashed), bump the basis commit to develop @27c5392, and reconcile the §4
heading + known-gaps note. The exit-6/--overwrite flow already matches
current develop (data.go:236), so it's left as-is.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@aptracebloc
aptracebloc merged commit e11f2de into developJul 13, 2026
17 checks passed
@aptracebloc
aptracebloc deleted the docs/cli-navigation-map branch July 13, 2026 09:42
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@LukasWodka@aptracebloc@saadqbal