Skip to content

docs(constructs): add description property to CLI construct tables [TREE-735][show]#250

Merged
pmallol merged 9 commits intomainfrom
paula/docs-check-description-cli
Apr 7, 2026
Merged

docs(constructs): add description property to CLI construct tables [TREE-735][show]#250
pmallol merged 9 commits intomainfrom
paula/docs-check-description-cli

Conversation

@pmallol
Copy link
Copy Markdown
Contributor

@pmallol pmallol commented Apr 6, 2026

Summary

Adds the description property to CLI construct reference pages, split out from #246 so the webapp/UI docs can be merged independently.

Construct config tables — added description row

  • constructs/api-check.mdx
  • constructs/browser-check.mdx
  • constructs/heartbeat-monitor.mdx
  • constructs/multistep-check.mdx
  • constructs/playwright-check.mdx
  • snippets/general-monitor-options-table.mdx (shared by TCP, URL, DNS, ICMP monitors)
  • detect/synthetic-monitoring/playwright-checks/configuration.mdx — added description to inherited properties list

Construct code examples — added description to basic & advanced examples

  • constructs/api-check.mdx
  • constructs/browser-check.mdx
  • constructs/multistep-check.mdx
  • constructs/heartbeat-monitor.mdx
  • constructs/playwright-check.mdx
  • constructs/url-monitor.mdx
  • constructs/dns-monitor.mdx
  • constructs/icmp-monitor.mdx
  • constructs/tcp-monitor.mdx

Overview pages — updated/added screenshots showing "Add description" button (light + dark)

  • detect/synthetic-monitoring/api-checks/overview.mdx — replaced existing images
  • detect/synthetic-monitoring/browser-checks/overview.mdx — upgraded to light/dark pair
  • detect/synthetic-monitoring/multistep-checks/overview.mdx — added new screenshot
  • detect/synthetic-monitoring/playwright-checks/overview.mdx — added new screenshot
  • detect/uptime-monitoring/dns-monitors/overview.mdx — added new screenshot
  • detect/uptime-monitoring/icmp-monitors/overview.mdx — added new screenshot
  • detect/uptime-monitoring/tcp-monitors/overview.mdx — upgraded to light/dark pair
  • detect/uptime-monitoring/url-monitors/overview.mdx — replaced existing images
  • detect/uptime-monitoring/heartbeat-monitors/overview.mdx — replaced existing images

@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Apr 6, 2026

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

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Apr 6, 2026, 1:57 PM

@pmallol pmallol requested a review from sujaya-sys April 6, 2026 16:28
@pmallol pmallol changed the title docs(constructs): add description property to CLI construct tables [TREE-735] docs(constructs): add description property to CLI construct tables [TREE-735][show] Apr 6, 2026
pmallol and others added 5 commits April 7, 2026 13:28
Co-authored-by: Susa Tünker <74345218+sujaya-sys@users.noreply.github.com>
Co-authored-by: Susa Tünker <74345218+sujaya-sys@users.noreply.github.com>
Co-authored-by: Susa Tünker <74345218+sujaya-sys@users.noreply.github.com>
Co-authored-by: Susa Tünker <74345218+sujaya-sys@users.noreply.github.com>
Co-authored-by: Susa Tünker <74345218+sujaya-sys@users.noreply.github.com>
Co-authored-by: Susa Tünker <74345218+sujaya-sys@users.noreply.github.com>
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