Skip to content

docs: add CLI documentation section#572

Merged
eskp merged 1 commit into
stagingfrom
docs/add-cli-section
Mar 15, 2026
Merged

docs: add CLI documentation section#572
eskp merged 1 commit into
stagingfrom
docs/add-cli-section

Conversation

@eskp
Copy link
Copy Markdown

@eskp eskp commented Mar 15, 2026

Summary

  • Add new CLI section to docs-site sidebar (next to API)
  • Includes overview, quickstart, concepts pages with Nextra frontmatter
  • 57 command reference pages sourced from the cli repo's cobra-generated docs
  • Remove stale GitHub Workflows and Testing sections from docs content

How it stays in sync

The cli repo gets a companion PR (KeeperHub/cli#13) adding a docs-sync.yml workflow that:

  1. Triggers on CLI releases (or manual dispatch)
  2. Regenerates command docs via go generate ./docs/...
  3. Copies them into docs/cli/commands/ and opens a PR here

Test plan

  • Verify docs-site builds locally (cd docs-site && pnpm dev)
  • Confirm CLI section appears in sidebar between FAQ and API
  • Verify command pages render correctly with working internal links

Add CLI section to docs-site sourced from the cli repo's auto-generated
command reference. Includes overview, quickstart, concepts, and 57
command pages generated by cobra/doc.
@eskp eskp merged commit e02f1a9 into staging Mar 15, 2026
19 checks passed
@eskp eskp deleted the docs/add-cli-section branch March 15, 2026 07:09
@github-actions
Copy link
Copy Markdown

🧹 PR Environment Cleaned Up

The PR environment has been successfully deleted.

Deleted Resources:

  • Namespace: pr-572
  • All Helm releases (Keeperhub, Scheduler, Event services)
  • PostgreSQL Database (including data)
  • LocalStack, Redis
  • All associated secrets and configs

All resources have been cleaned up and will no longer incur costs.

@github-actions
Copy link
Copy Markdown

ℹ️ No PR Environment to Clean Up

No PR environment was found for this PR. This is expected if:

  • The PR never had the deploy-pr-environment label
  • The environment was already cleaned up
  • The deployment never completed successfully

eskp added a commit that referenced this pull request Mar 15, 2026
The middleware route allowlist was not updated when the CLI section
was added in #572, causing all /cli/* pages to rewrite to /404.

Also add a local postcss config so the docs-site dev server stops
inheriting the root project's Tailwind-based postcss config.
Sign up for free to 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