docs(faq): stop troubleshooting connectors that do not exist - #1590
Merged
Conversation
The FAQ's Integrations section told a reader whose email was not logging to check that the Gmail / Outlook connector is connected under `Settings → Email`, and a reader whose contract had not updated to open the DocuSign integration log under `Setup → Integrations → DocuSign → Activity`. Neither connector ships — `src/` carries no connector metadata and no installed platform package supplies one — so neither screen exists, and there is no `Settings` app at all. `Setup → Integrations` is real, but as this app ships it holds exactly the two entries the platform contributes, Connect an Agent and Datasources. Both answers now say what actually ships and point at `/docs/guides/integrations`, matching the shape #1401 gave the neighbouring Stripe answer on this page. Three locales. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DuzfS5chho38Yx1jxx9DEj
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
Link Check (`link-check.yml`) went red on the changeset, not on the docs pages. The action runs `file-extension: .md` with `check-modified-files-only`, so the three `.mdx` files are out of its scope entirely and the changeset is the only file it opens. It has no base URL, so it fetched the two site-absolute paths as URLs and both returned 400. The two guide pages are now named in prose with their paths in backticks. No markdown link syntax is left in the file, and the three `.mdx` pages are untouched — their links are site-absolute on purpose and are never read by this job. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DuzfS5chho38Yx1jxx9DEj
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.
Fixes #1402
The FAQ's 🔌 Integrations section troubleshot two connectors that do not exist, in the imperative. Both answers are rewritten in the shape PR #1401 gave the neighbouring Stripe answer on this same page: say what actually ships, point at Integrations, and drop the troubleshooting steps for a connector that cannot be misconfigured because it is not there. Three locales.
What was wrong, re-measured on this branch's base (
main@1486ec0, not the021db54the card quotes)Settingsapp: the shipped apps are HotCRM (src/apps/crm.app.ts) plus the platform'sSETUP_APP/STUDIO_APP/ACCOUNT_APP, labelled Setup / Studio / Accountguides/email-and-calendar.mdxfiles address-matched logging under How email logging works (not shipped yet) and says exclusion lists are "not shipped"grep -rn 'DocuSign' src/→ 0 (reverse control:grep -rn 'crm_lead' src/→ 198). No connector, therefore no log and no webhook to retrySetup → Integrationsitself is real — it resolves live as a Setup group label — but as this app ships it holds exactly the two platform-contributed entries, Connect an Agent and Datasources, and no vendor mounts anything under it. Ground truth re-read offcontent/docs/guides/integrations.mdx(the page #756 fixed) rather than taken from a summary.What the answers say now
src/actions/contact.actions.ts,visible: record.email_opt_out == false), and delivers only through the mail transport a deployment configures. Links Email & Calendar and Integrations.Headings are untouched, so anchors and the search paths a reader arrives on are unchanged, and a reader who searches "DocuSign" still lands on the answer — which now tells them it does not exist.
What the checks establish, and what they do not
pnpm test— 159 files, 3380 passed, 1 skipped, exit 0.apps/docs(its own lockfile, outside the root pnpm project;docs-app.yml):pnpm install --frozen-lockfile+pnpm run types:check+pnpm run buildall exit 0, 201 doc paths prerendered.Named guards, read before committing and re-read after:
docs-locale-callouts— blockquote runs per locale trio:0 / 0 / 0atHEAD,0 / 0 / 0after. The trio stays balanced, and all three files stay the same length (194 lines each).docs-view-rosters— the FAQ carries no## Standard list viewssection in any locale, so this guard has nothing to count here. Green, and green over nothing.docs-anchor-links— every new internal link is unanchored, so this guard does not judge them; the four target pages were checked to exist by hand, in each locale.docs-setup-navigation-names— this one does see the new text: rule 2 parses the bold**Setup → Integrations**(en/zh-Hant) and**设置 → 集成**(zh-Hans) citations and resolves the second segment live against the shipped roster.Reverse verification of that last claim (the ablation), because a green guard is not evidence on its own. Predicted direction: red on mutation.
**App → …**citation, so #853's navigation rule never parsed either one and #1117's widening does not reach them. Every green above is evidence about the trio's structure, the docs build, and the new bold citations — not about whether more prose on this page names machinery that does not exist. The count below is a hand sweep, and it is the only evidence for that.The #756 sweep of the rest of
reference/faq*.mdxSwept all three locales for connector and integration claims (
connector|integrat|webhook|Slack|Zapier|Stripe|Twilio|…) and for every navigation path in the file, resolving each first segment against the platform roster.Setup → AIgroup that does not exist — Setup ships no AI group, and the guard cannot see either line because both are italic #1591 (the AI Copilot answers citeSetup → AI → HealthandSetup → AI → Knowledge Bases → Refresh; Setup ships noAIgroup — it is a Studio group) and Twelve links inside localized docs pages drop the locale prefix, so a Chinese reader clicking them lands on the English page #1592 (12 site-absolute/docs/…links inside localized pages, 2 of them left on this page by Resolve this app's own sidebar citations, and ban a Stripe action that never existed #1401, that drop a Chinese reader onto the English page).Scope
content/docs/reference/faq{,.zh-Hans,.zh-Hant}.mdx+ the changeset — the dispatched surface exactly, nosrc/, notest/. No guard entry was added: a rule-1 ban on the retired names would live intest/docs-setup-navigation-names.test.ts, which is off-surface, and the card is explicit that the reader-facing correction is the deliverable.🤖 Generated with Claude Code
https://claude.ai/code/session_01DuzfS5chho38Yx1jxx9DEj