Rework general quickstart around the AI-agent setup flow#413
Merged
Conversation
Add the SetupFlow visual, lead with the recommended agent path, and drop the Slack alert example that needs a pre-connected workspace.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reworks the General Quickstart to lead with the recommended AI-agent setup path while keeping the manual CLI flow as a fallback, and adds a new visual “Setup → Generate → Test → Deploy → Monitor” component to illustrate the end-to-end workflow.
Changes:
- Added a new interactive
SetupFlowsnippet component to visualize the recommended Checkly workflow (with mobile fallback rendering). - Rewrote
/quickstarts/generalto emphasize the AI-agent setup flow first, with the manual CLI walkthrough as an alternative. - Added the General Quickstart page to the docs navigation under Getting Started → Quickstarts.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| snippets/setup-flow.jsx | New interactive workflow visual used by the General Quickstart. |
| quickstarts/general.mdx | New General Quickstart content centered on the AI-agent setup flow plus manual fallback steps. |
| docs.json | Adds quickstarts/general to the Quickstarts navigation group. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| You'll see the results in your terminal: | ||
|
|
||
| ``` |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Relabel each relocated quickstart to 'Quickstart' and list it first in its section group, promote the general guide to a top-level Quickstart page, add redirects from the old /quickstarts/* URLs, and update internal links.
Merge the welcome screenshot and setup bullets into the quickstart's first step, remove the orphaned page, and redirect its old URLs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Affected Components
Notes for the Reviewer
Reworks
/quickstarts/generalto lead with the recommended AI-agent setup path, with the manual CLI walkthrough kept as a fallback.Changes:
SetupFlowvisual (snippets/setup-flow.jsx) showing setup → generate → test → deploy → monitor, with a caption tying it to the recommended flow.SlackAppAlertChannelneeds a pre-connected Slack workspace, so it fails when pasted by a first-time user. The alerts step now shows Email + Phone; Slack stays discoverable via the alert channels overview link.Note
This is a clean re-branch of the work previously on
giordanodaniel-general-quickstart, which got force-pushed and diverged. That PR should be closed in favor of this one.New Dependency Submission
None.
Screenshots
The
SetupFlowcomponent is the main visual change — worth previewing the rendered/quickstarts/generalpage.