Skip to content

docs: reorganize CLI commands into categorical folders#204

Open
thebiglabasky wants to merge 4 commits intomainfrom
herve/cli-commands-reorganize
Open

docs: reorganize CLI commands into categorical folders#204
thebiglabasky wants to merge 4 commits intomainfrom
herve/cli-commands-reorganize

Conversation

@thebiglabasky
Copy link
Contributor

Summary

  • Reorganizes the 17 CLI command reference pages into 5 semantic subfolders under cli/
  • checkly skills stays at the CLI root as the cross-cutting AI entry point
  • All internal links and docs.json navigation updated

Proposed structure

cli/
├── checkly-skills.mdx              ← root level
├── account/      → login, logout, switch, whoami, runtimes
├── configure/    → env, import, sync-playwright
├── testing/      → test, pw-test
├── monitoring/   → deploy, destroy, trigger, checks
└── communicate/  → incidents, status-pages

Alternative: condensed (3 folders)

If 5 subgroups feels like too much, here's a more condensed option:

cli/
├── checkly-skills.mdx              ← root level
├── account/      → login, logout, switch, whoami, runtimes, env, import, sync-playwright
├── workflow/     → test, pw-test, deploy, destroy, trigger, checks
└── communicate/  → incidents, status-pages

This merges configure/ into account/ and testing/ + monitoring/ into a single workflow/ group.

Test plan

  • Verify sidebar navigation renders correctly with nested groups
  • Spot-check internal links resolve to the correct pages
  • Review folder groupings with team

🤖 Generated with Claude Code

Move CLI command reference pages into semantic subfolders:
- account/ - login, logout, switch, whoami, runtimes
- configure/ - env, import, sync-playwright
- testing/ - test, pw-test
- monitoring/ - deploy, destroy, trigger, checks
- communicate/ - incidents, status-pages

checkly-skills stays at the CLI root as the cross-cutting entry point.
All internal links and docs.json navigation updated accordingly.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@stefanjudis
Copy link
Collaborator

Uff... This is very hard and I can't really say I have a strong opinion here, but my first thought was leaning towards actions and resources. actions might not be the right word, but yeah... I thought of this.

cli/
├── checkly-skills.mdx     ← root level
├── actions/       → login, logout, switch, whoami, runtimes, import, sync-playwright, deploy, destroy, trigger, pw-test
├── platform/      → env, runtimes, checks, incidents, status-pages

This is very hard. But I'm generally on board with your proposal. This won't perfect but we need to start grouping things.

- [`checkly logout`](/cli/checkly-logout) - Sign out of your Checkly account
- [`checkly whoami`](/cli/checkly-whoami) - Display current account information
- [`checkly switch`](/cli/checkly-switch) - Switch between multiple accounts
- [`checkly logout`](/cli/account/checkly-logout) - Sign out of your Checkly account
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

heads up: you'll have to set "a thousand" redirects in the marketing repo then. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Urf. True. Are there ways to keep folders without changing the URL? 🤓

@thebiglabasky
Copy link
Contributor Author

Uff... This is very hard and I can't really say I have a strong opinion here, but my first thought was leaning towards actions and resources. actions might not be the right word, but yeah... I thought of this.

cli/
├── checkly-skills.mdx     ← root level
├── actions/       → login, logout, switch, whoami, runtimes, import, sync-playwright, deploy, destroy, trigger, pw-test
├── platform/      → env, runtimes, checks, incidents, status-pages

This is very hard. But I'm generally on board with your proposal. This won't perfect but we need to start grouping things.

Yes, I'm very open to alternatives. I think it depends on what we want to convey in terms of "areas" the CLI covers. The current way made me feel overall OK about the match between the commands and their respective folders, so I'd be fine with this for a start.

At least as long as we don't need to do redirects 😬

thebiglabasky and others added 2 commits March 5, 2026 12:29
- Add Required column to all options tables across all command pages
- Standardize argument names to lowercase (ID → id)
- Fix ResponseField short flag pattern to use name="--flag, -f" everywhere
- Add missing type attributes to ResponseFields (trigger, pw-test)
- Add missing related commands to checkly-whoami

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Adds slug field to all moved command pages so URLs remain at
/cli/checkly-* regardless of folder structure. Reverts internal
links back to the original slug-based paths.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Mintlify resolves page entries in docs.json to URLs, so they need
to match the slug values rather than the file paths to avoid
sidebar links exposing the folder structure.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

2 participants