Repository navigation
docs: document intent for supported checks and monitors - #570
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
stefanjudis
marked this pull request as ready for review
October 14, 2026 10:25
stefanjudis
approved these changes
Oct 14, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
intentfrom 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 thenullclearing workaround, and does not claim the CLI fix has shipped.Source verification
Verified against checkly/checkly-cli revision
32feaaadf0734a2e6d298fea1fa3b9f65cacefd0:Validation
git diff --checkpassed.mint broken-links: passed, no broken links found.Source request: https://checklyhq.slack.com/archives/C0AHPMHJM7S/p1791972107071169