Add end-to-end API monitoring guide and onboarding plan - #538
Open
Dgiordano33 wants to merge 6 commits into
Open
Dgiordano33 wants to merge 6 commits into
Dgiordano33 wants to merge 6 commits into
Conversation
Net new guides/api-monitoring.mdx that folds the OpenAPI, setup/teardown, and Stripe API guides into one walkthrough: assertions on status, headers, and body, degraded vs failed thresholds, and an authenticated write with setup and teardown scripts. Sample deployed to Checkly Marketing as docs-guide-api-monitoring. Screenshot scenes added; captures pending harness re-auth. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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
Adds an end-to-end API monitoring guide with a verified Checkly sample, OpenAPI-based checks, setup and teardown scripts, failure/degraded-state examples, and supporting screenshots.
Updates guide navigation and the overview, moves global monitoring into Getting started, and codifies action-oriented unnumbered guide headings.
Replaces the completed guides overhaul plan with a data-informed onboarding guides plan covering ten follow-up guides and their success metrics.
New Dependency Submission
The sample project pins Checkly and Playwright development dependencies so readers can install and run the documented checks reproducibly.
Screenshots
Includes group configuration and failing assertion screenshots in
images/guides/api-monitoring/.