docs: reorganize CLI commands into categorical folders#204
docs: reorganize CLI commands into categorical folders#204thebiglabasky wants to merge 4 commits intomainfrom
Conversation
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>
|
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. This is very hard. But I'm generally on board with your proposal. This won't perfect but we need to start grouping things. |
cli/account/checkly-login.mdx
Outdated
| - [`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 |
There was a problem hiding this comment.
heads up: you'll have to set "a thousand" redirects in the marketing repo then. :)
There was a problem hiding this comment.
Urf. True. Are there ways to keep folders without changing the URL? 🤓
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 😬 |
- 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>
Summary
cli/checkly skillsstays at the CLI root as the cross-cutting AI entry pointdocs.jsonnavigation updatedProposed structure
Alternative: condensed (3 folders)
If 5 subgroups feels like too much, here's a more condensed option:
This merges
configure/intoaccount/andtesting/+monitoring/into a singleworkflow/group.Test plan
🤖 Generated with Claude Code