Skip to content

docs: list Rocky AI as a prerequisite for checkly rca [RED-1380] - #788

Open
sorccu wants to merge 1 commit into
mainfrom
simo/red-1380-rca-rocky-ai-prereq
Open

sorccu wants to merge 1 commit into
mainfrom
simo/red-1380-rca-rocky-ai-prereq

Conversation

@sorccu

@sorccu sorccu commented Nov 5, 2026

Copy link
Copy Markdown
Member

Linear: RED-1380

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

Notes for the Reviewer

checkly rca run fails when Rocky AI is switched off for the account, but the checkly rca page didn't list it as a prerequisite. This adds it, with the note that an account owner turns it on in the Rocky AI settings.

Related: checkly/checkly-cli#1593 (the CLI now names this cause in its error). Independent of it; can merge any time.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Nov 5, 2026, 12:46 PM

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ready to merge · The new prerequisite is accurate for checkly rca run: the API routes that trigger an analysis require the account's Rocky AI opt-in, and only the Owner role can switch it on. One optional suggestion scopes it to run, because checkly rca get works without the opt-in.

Merge readiness

  • CI: all checks pass (docs-gate, preview-checks, static-docs-checks, Mintlify link-rot and vale).
  • Mergeable, state CLEAN. main has not touched cli/checkly-rca.mdx since the merge base e905ff08.
  • Overlap: the draft #774 (casing sweep) also edits cli/checkly-rca.mdx, on other lines. Either order works; this one-line PR can go first.
  • The link matches the form main already uses for this settings page (https://app.checklyhq.com/accounts/rocky-ai in ai/rocky-ai.mdx, resolve/ai-root-cause-analysis/overview.mdx, resolve/automatic-check-repair.mdx), and it agrees with resolve/ai-root-cause-analysis/overview.mdx:29, which already asks readers to enable Rocky AI before using RCA.

Inline comments: 1 Wording (optional).

What I checked
  • Read the diff from merge base e905ff08 and the full PR version of cli/checkly-rca.mdx.
  • gh pr checks 788, gh pr view 788 --json mergeable,mergeStateStatus, gh pr list --json number,files, git log e905ff08..origin/main -- cli/checkly-rca.mdx (no commits).
  • monorepo origin/main@d9aff4a355: in apps/backend/api/src/modules/public-api/rocky-ai/routes.ts, the two routes that trigger an analysis (POST /v1/root-cause-analyses/error-groups/{id} and .../test-session-error-groups/{id}) require the account's Rocky AI opt-in feature, and GET /v1/root-cause-analyses/{id} requires only the read permission. packages/models/src/feature-flags/flags.ts describes that feature as the account-level Rocky AI opt-in. The backend role-permission snapshot grants account:update-ai-opt-in to OWNER only, and AccountsController.ts enforces it when the feature is toggled. In apps/webapp/src/pages/rocky-ai/PageRockyAiList.vue the toggle is labeled Enable Rocky AI (i18n/en.ts) and sits behind that permission; the breadcrumb names the page "Rocky AI settings".
  • checkly/checkly-cli#1593 (open): rca run now reports the API's ERR_ROCKY_AI_DISABLED 403 and points to the same settings page. As the description says, the docs change does not depend on it.
  • admin/team-management/permissions.mdx:288 already lists account:update-ai-opt-in.
  • End-to-end tests: not run. The PR adds no runnable sample, and the claim depends on account feature state, which the backend source settles.

Comment thread cli/checkly-rca.mdx
- Checkly CLI installed
- Valid Checkly account authentication (run `npx checkly login` if needed)
- A Checkly plan that includes root cause analysis
- Rocky AI enabled for the account (an account owner turns it on in the [Rocky AI settings](https://app.checklyhq.com/accounts/rocky-ai))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Wording (optional) · Only the routes that trigger an analysis require the opt-in. GET /v1/root-cause-analyses/{id}, which checkly rca get calls, checks only the read permission, so readers can still fetch existing analyses with Rocky AI off. This version scopes the item to run, drops the parenthetical, capitalizes the role (editing rules: Owner, Admin), and names the toggle:

Suggested change
- Rocky AI enabled for the account (an account owner turns it on in the [Rocky AI settings](https://app.checklyhq.com/accounts/rocky-ai))
- Rocky AI enabled for the account, to run new analyses with `checkly rca run`. An account Owner turns on **Enable Rocky AI** in the [Rocky AI settings](https://app.checklyhq.com/accounts/rocky-ai).

This branch was successfully deployed

1 active deployment
staging — e878977d Deployed Nov 5, 2026 by mintlify[bot]
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