docs(constructs): add check description property [TREE-735] [show]#246
Open
docs(constructs): add check description property [TREE-735] [show]#246
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
pmallol
force-pushed
the
paula/docs-check-description
branch
from
5a2e87d to
8c09676
Compare
pmallol
changed the title
sujaya-sys
reviewed
Apr 2, 2026
detect/synthetic-monitoring/playwright-checks/configuration.mdx
Outdated
Show resolved
Hide resolved
Contributor
|
@pmallol Should we update the alert docs as well with the new {{CHECK_DESCRIPTION}} variable? LMK if you'd like me to look into that :) |
Contributor
Author
This is done and I restored the text in places CC rephrase things unnecessarily... 😠 Apologies, it slipped my review |
pmallol
changed the title
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
2 participants
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.
Affected Components
Notes for the Reviewer
Documents the
descriptionproperty across all check/monitor pages and updates Rocky AI docs to reference it as an analysis artifact.The description field is:
string, optional, defaults tonull, supports markdown, max 500 characters.Construct reference pages — added
descriptionto config tablesconstructs/api-check.mdx— General Check tableconstructs/browser-check.mdx— General Check tableconstructs/multistep-check.mdx— General Check tableconstructs/heartbeat-monitor.mdx— General Monitor tableconstructs/playwright-check.mdx— General Check tablesnippets/general-monitor-options-table.mdx— shared snippet (covers TCP, URL, DNS, ICMP monitors)Check/monitor configuration pages — added description field + Rocky AI context
detect/synthetic-monitoring/api-checks/configuration.mdx— new "Additional Settings" sectiondetect/synthetic-monitoring/playwright-checks/configuration.mdx— Tip block after inherited properties listdetect/uptime-monitoring/dns-monitors/configuration.mdx— Description bullet in "Additional Settings"detect/uptime-monitoring/icmp-monitors/configuration.mdx— Description bullet in "Additional Settings"detect/uptime-monitoring/tcp-monitors/configuration.mdx— Description bullet in "Additional Settings"detect/uptime-monitoring/url-monitors/configuration.mdx— new "Additional Settings" sectiondetect/uptime-monitoring/heartbeat-monitors/configuration.mdx— new "Additional Settings" sectionRocky AI pages — added check description to artifacts list
resolve/ai-root-cause-analysis/overview.mdx— added "check description" to the artifacts listplatform/rocky-ai.mdx— added "check descriptions" to the capabilities summary