Skip to content

Expand & cross-link the datumctl CLI documentation - #38

Merged
scotwells merged 1 commit into
docs/datumctl-pluginsfrom
docs/datumctl-cli-guides
Jul 2, 2026
Merged

Expand & cross-link the datumctl CLI documentation#38
scotwells merged 1 commit into
docs/datumctl-pluginsfrom
docs/datumctl-cli-guides

Conversation

@scotwells

Copy link
Copy Markdown
Contributor

Expands the datumctl (CLI) documentation section from a thin set of pages into a coherent, well-linked guide, and makes information flow between every doc with descriptive link text.

New guides

  • Quickstart — install → log in → set context → first command.
  • Contexts & scoping — the organization/project model, datumctl ctx, and the --organization/--project flags (the Fix writing style and tone inconsistencies #1 source of "why do I see nothing?" confusion).
  • Output formats & scripting-o formats, structured --error-format, and automation/agent patterns.
  • Discovering resources & schemasapi-resources, api-versions, and explain.
  • Interactive consoledatumctl console panes, navigation, dashboards, and in-console login.
  • AI assistant & MCPdatumctl ai and the datumctl mcp server (cross-linked with the Agents-tab MCP page).
  • Using datumctl with kubectl — opt-in auth update-kubeconfig/whoami/can-i for kubectl users only.

Section-wide weave

  • Restructured the CLI tab into groups: Getting started · Core concepts · Interactive & AI · Plugins · Reference & interop.
  • Un-orphanedworking-with-resources and console (both were missing from the nav) and de-duplicated overlapping content down to single canonical homes.
  • Added descriptive cross-links (no bare URLs or "click here") throughout the new and existing docs so readers move naturally between related tasks.

Every command, flag, and keybinding was verified against the datumctl source. docs.json validated.

Stacked on docs/datumctl-plugins (PR #37) so the plugin cross-links resolve — retarget to main once that merges.

🤖 Generated with Claude Code

Add quickstart, contexts & scoping, output & scripting, discovering
resources, interactive console, AI & MCP, and kubectl interop guides.
Restructure the CLI section into groups, un-orphan the resources and
console pages, and weave descriptive cross-links across every doc.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@scotwells

Copy link
Copy Markdown
ContributorAuthor

Folded into #37 so the CLI guides and plugin docs share one preview environment. All commits are now on docs/datumctl-plugins.

@scotwells
scotwells merged commit 1fa02f6 into docs/datumctl-pluginsJul 2, 2026
2 checks passed
@scotwells
scotwells deleted the docs/datumctl-cli-guides branch July 2, 2026 04:36
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.

1 participant

@scotwells