docs(quickstart): rewrite as a self-contained Diátaxis tutorial - #659
Open
dionlow wants to merge 9 commits into
Open
docs(quickstart): rewrite as a self-contained Diátaxis tutorial#659dionlow wants to merge 9 commits into
dionlow wants to merge 9 commits into
Conversation
Turn the Quickstart into a proper learning-oriented tutorial a first-time builder can complete without leaving the page, following the MailMonkey ⇄ Salesforce scenario. - Add tutorial framing: "What you'll build", "Prerequisites" (now including the amp CLI install, linked to /cli/overview), and "What you'll have at the end". - Inline the minimum steps for creating a Salesforce provider app and a webhook destination, keeping the deep guides as "learn more" links. - Add per-step success checkpoints and a "What's next" section. - Trim the reference-heavy amp.yaml to a minimal manifest; defer full options to /manifest-reference. Fixes: - Integration name mismatch: React snippet now uses integration="mailmonkey-salesforce" to match the amp.yaml name and the published sample. - Malformed link: [Destinations](destinations) -> [Destinations overview](/destinations/overview). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Replace em-dashes with commas, colons, and periods so the phrasing matches the sibling provider/destination guides. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
dionlow
force-pushed
the
quickstart-diataxis-tutorial
branch
from
July 22, 2026 19:40
b066e8d to
af4b9fd
Compare
Use a current dashboard screenshot of the API keys page and point the reader to the "API keys" section instead of project settings. Added as a new image so the shared create-api-key.png used by api/key-auth.mdx is left untouched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a small <Where> pill component and tag each step with where the action happens (Ampersand Dashboard, Salesforce, Ampersand CLI, or MailMonkey), plus a legend up front, so readers can track which tool they're in. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Switch the <Where> pills from solid saturated fills to soft tinted backgrounds with desaturated text and a faint border, so they read as subtle labels. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Use a current dashboard screenshot of the OAuth Provider Apps page. Added as a new image so the shared dd47b7a-Ampersand.png used by ~45 provider guides is left untouched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@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
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.
Summary
Rewrites
src/quickstart.mdxfrom a tutorial↔how-to↔reference hybrid into a proper Diátaxis tutorial — a first-time builder can now complete the MailMonkey ⇄ Salesforce integration start-to-finish on the page. The full sample it targets: https://github.com/amp-labs/samples/blob/main/quickstart/amp.yamlWhat changed
ampCLI, linked to/cli/overview), and "What you'll have at the end".amp.yamlto a minimal teaching manifest; the full option set is deferred to/manifest-referenceand the GitHub sample.Correctness fixes
integration="readContactsAndLeads"while the YAML definesname: mailmonkey-salesforce. Now both usemailmonkey-salesforce, so the sample actually works.[Destinations](destinations)(bare relative, no leading slash) →[Destinations overview](/destinations/overview).Verification
/images/...paths exist undersrc/images/.<img>for screenshots, doubled code-fence labels).🤖 Generated with Claude Code