Skip to content

Document missing CLI command references#442

Merged
thebiglabasky merged 2 commits into
mainfrom
herve/docs-cli-alert-channels
Jul 15, 2026
Merged

Document missing CLI command references#442
thebiglabasky merged 2 commits into
mainfrom
herve/docs-cli-alert-channels

Conversation

@thebiglabasky

Copy link
Copy Markdown
Contributor

Summary

  • add a complete public reference for checkly alert-channels list, get, and logs
  • document the canonical checkly members family on its own page and keep the legacy account spelling as a compatibility note
  • document checkly import plan explicitly, including --preview and the correct --root syntax
  • point users from the deprecated checkly rules command to checkly skills
  • add the new pages to CLI navigation and the generated sitemap

Why

Several public CLI commands had shipped without matching public command references. The member commands were documented only through hidden compatibility aliases, the import page omitted the canonical plan spelling and a current flag, and the deprecated rules command had no public migration notice.

This change audits the generated Oclif manifest against the CLI reference. All 48 product commands now have a public page or section; only Oclif's built-in help command is intentionally excluded.

Validation

  • generated CLI help smoke tests for alert channels, members, import plan, and rules
  • 158 focused CLI command, formatter, and metadata tests
  • manifest-to-docs coverage audit
  • python3 .github/scripts/check_frontmatter.py
  • python3 .github/scripts/check_redirect_destinations.py
  • npm run generate-sitemap
  • npx mint broken-links
  • git diff --check

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Jul 15, 2026, 2:25 PM

@thebiglabasky thebiglabasky marked this pull request as ready for review July 15, 2026 14:28
@thebiglabasky thebiglabasky merged commit 912decc into main Jul 15, 2026
7 of 9 checks passed
@thebiglabasky thebiglabasky deleted the herve/docs-cli-alert-channels branch July 15, 2026 14:30
@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
checkly-422f444a 🟡 Building Jul 15, 2026, 2:21 PM

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