Add syntax highlighting to construct documentation code examples#36
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds syntax highlighting annotations to code examples across construct documentation files. The changes make code examples more readable by highlighting specific relevant lines in TypeScript code blocks.
- Updated all MDX files to include
highlightattributes in code blocks - Standardized formatting for usage sections and fixed some inconsistencies
- Cleaned up documentation content and removed TODO comments
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| webhook-alert-channel.mdx | Added line highlighting to all usage examples and standardized formatting |
| url-monitor.mdx | Added syntax highlighting to code examples |
| tcp-monitor.mdx | Added syntax highlighting and improved usage documentation |
| status-page.mdx | Added line highlighting to TypeScript examples |
| status-page-service.mdx | Added syntax highlighting to usage example |
| sms-alert-channel.mdx | Added highlighting and fixed parameter ordering |
| slack-alert-channel.mdx | Added line highlighting to all code examples |
| retry-strategy.mdx | Added highlighting and standardized usage formatting |
| project.mdx | Added highlighting and improved code examples |
| playwright-check.mdx | Cleaned up content, removed TODOs, and added comprehensive highlighting |
| multistep-check.mdx | Added syntax highlighting to usage examples |
| maintenance-window.mdx | Added highlighting and improved documentation structure |
| heartbeat-monitor.mdx | Added line highlighting to all usage examples |
| email-alert-channel.mdx | Added syntax highlighting and standardized formatting |
| dashboard.mdx | Added comprehensive line highlighting to examples |
| check-group.mdx | Added highlighting and import statements |
| check-group-v2.mdx | Added highlighting and import statements |
| browser-check.mdx | Added line highlighting and import statements |
| api-check.mdx | Added highlighting to all code examples |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Added the last missing pieces for the PWN check docs.