Skip to content

docs: document intent for supported checks and monitors - #570

Merged
stefanjudis merged 11 commits into
mainfrom
angie/document-check-intent-20261014
Oct 14, 2026
Merged

stefanjudis merged 11 commits into
mainfrom
angie/document-check-intent-20261014

Conversation

@checkly-rca-bot-angie

@checkly-rca-bot-angie checkly-rca-bot-angie Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The live Playwright construct reference and current construct docs omit intent. Add a shared reference and property-table entries for all nine CLI-supported types: API, Browser, Multistep, Playwright, URL, TCP, DNS, ICMP, and gRPC.

Document the goal/typed constraints shape, limits, whitespace trimming, and the distinction from descriptions, executable assertions, and automatic repair enablement. Keep the generic monitor table unchanged so SSL, heartbeat, and traceroute do not advertise unsupported options.

Intended CLI behavior

Per Stefan’s review, removing intent from code should clear the intent stored on the check. The CLI behavior will be fixed separately. This docs PR deliberately does not document the current preserve-on-omission behavior or the null clearing workaround, and does not claim the CLI fix has shipped.

Source verification

Verified against checkly/checkly-cli revision 32feaaadf0734a2e6d298fea1fa3b9f65cacefd0:

Validation

  • git diff --check passed.
  • API navigation tests: 6 passed.
  • Legacy redirect destination check: 179 passed.
  • API group badge/schema consistency passed.
  • Executed the documented intent example through a local harness using the current CLI source validation methods (not stale compiled output); valid example, goal-only, null and omitted values passed, invalid blank/length/type/count cases were rejected. This is scoped example validation, not the full CLI test suite.
  • Sitemap regeneration produced no changes.
  • mint broken-links: passed, no broken links found.
  • CI and rendered preview are not yet verified.

Source request: https://checklyhq.slack.com/archives/C0AHPMHJM7S/p1791972107071169

@mintlify

mintlify Bot commented Oct 14, 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 Oct 14, 2026, 11:22 AM

@stefanjudis
stefanjudis removed the request for review from sorccu October 14, 2026 11:22
@stefanjudis
stefanjudis enabled auto-merge October 14, 2026 11:22
@stefanjudis
stefanjudis merged commit 6046e88 into main Oct 14, 2026
6 checks passed

This branch was successfully deployed

1 active deployment
staging — 45ec1c99 Deployed Oct 14, 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.

1 participant