-
Notifications
You must be signed in to change notification settings - Fork 4
Add PCS video and clean up some areas #95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation, configuration files, and package dependencies across the Checkly documentation repository. The changes primarily focus on improving quickstart guides, fixing formatting issues, and updating numerous npm package versions to their latest releases.
Key Changes:
- Enhanced quickstart documentation with improved structure, embedded video content, and consistent tip sections linking to overview pages
- Fixed numerous spelling and formatting issues (trailing whitespace, typos)
- Updated 100+ npm package dependencies to newer versions in package-lock.json
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| quickstarts/playwright-check.mdx | Added YouTube embed, improved documentation flow, fixed spelling error ("Lern" → "Learn") |
| quickstarts/url-monitor.mdx | Repositioned tip section for better content flow |
| quickstarts/tcp-monitor.mdx | Repositioned tip section, removed trailing whitespace |
| quickstarts/multistep-check.mdx | Added tip section, removed trailing whitespace |
| quickstarts/heartbeat-monitor.mdx | Added tip section, fixed whitespace formatting |
| quickstarts/browser-check.mdx | Added tip section, reordered imports, removed mode setting, fixed whitespace |
| quickstarts/api-check.mdx | Added tip section, removed trailing whitespace |
| snippets/youtube-embed.jsx | Added comprehensive JSDoc documentation, removed trailing whitespace |
| package-lock.json | Updated numerous package versions (e.g., @mintlify/cli, react, shiki, etc.) |
| docs.json | Reordered quickstart pages, added Platform/Private Location group |
| detect/synthetic-monitoring/playwright-checks/overview.mdx | Removed extra blank line |
| constructs/quickstarts/playwright-check.mdx | Removed mode setting |
| constructs/private-location.mdx | Fixed link path and sidebar title |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,3 +1,28 @@ | |||
| /** | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just added some JSDoc types so that my editor stops complaining about any types. :D
MariadeAnton
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stefanjudis small bits and bots on top of your clean up.
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
Co-authored-by: María de Antón <[email protected]>
|
Great review. @MariadeAnton is fine with moving forward. :) 🎉 |
Affected Components
Notes for the Reviewer
I started this PR and only wanted to add a new video but got carried away a little.
Revised Playwright Check Suites Getting started and new explainer video
Unified CTAs at the beginning of all quick starts
Etc...
Fixed inconsistent rendering in quick starts
Some quick starts didn't render the sidebar. Now they all do.
Made the TCP quick start discoverable
The page was there but it wasn't linked
Brought back the
PrivateLocationconstructThe page for the private locations wasn't included in the sidebar
Update
mintCLII was debugging something and updated the mintlify cli!