Skip to content

[Docs] Correct remaining provider and setup guidance - #3691

Draft
roomote-community[bot] wants to merge 1 commit into
developfrom
fix/docs-accuracy-audit-0dxp5y4pknr4n
Draft

roomote-community[bot] wants to merge 1 commit into
developfrom
fix/docs-accuracy-audit-0dxp5y4pknr4n

Conversation

@roomote-community

Copy link
Copy Markdown
Contributor

​Opened on behalf of @mrubens. Follow up by mentioning @roomote, in the web UI, or in Discord.

Related issue

Scheduled documentation accuracy audit; no separate issue.

Why this PR exists

  • A maintainer explicitly invited this PR in the linked issue or discussion
  • I am a maintainer / this is internal Roomote work

The all-page reading pass found remaining inaccuracies against v1.20.2 source and current vendor guidance. Earlier audits #3468 and #3515 and optional-chat correction #3514 were closed without merging. Open audits #3594 and #3647 and narrower #3593, #3599, #3617, #3669 and #3677 were checked by status and diff to avoid duplicating pending corrections.

What changed

  • Align the product and integration overviews with optional chat and the dashboard first-task flow; distinguish source-control API reads from local execution.
  • Correct inference setup's actual save-time failure policy and Z.AI's environment-region defaults and vision-role terminology.
  • Explain that switching from ChatGPT subscription limits to OpenAI API billing requires disconnecting the subscription.
  • Update Granola's existing-space API controls and admin restriction, AgentMail's free custom-domain entitlement, and a stale recipe description.

This changes nine documentation pages only. Baselines are develop 73fc55cc7 and shipped main/v1.20.2 6265e1d25; their application and documentation content matches. No unreleased implementation is presented as shipped.

Audit scope: all 122 current public MDX pages were read, but independent claim-by-claim verification of the entire site remains incomplete. The findings and claim evidence and full per-page ledger distinguish checked source contracts from reading-only coverage and untested behaviors. This patch does not certify the remaining docs accurate.

How it was tested

  • mise exec -- pnpm --filter @roomote/docs check passed pinned Mintlify build validation and broken-link checks.
  • mise exec -- pnpm --filter @roomote/docs check-cookbook-index passed; seven recipes current.
  • Supplemental checks covered 114 navigation routes with no missing local targets. The existing routing-heading mismatch remains covered by [Docs] Correct stale public setup and workflow guidance #3647.
  • Status-only HEAD probes covered 143 literal external URLs: 102 succeeded; 41 had non-success statuses or connection errors. Existing icon/Requesty failures are covered by pending audits; deliberate example.com placeholders and 403/405/429/timeouts are not classified as broken content. Detailed status results.
  • Corrected claims were checked against owning source and authoritative Granola/AgentMail documentation. Genuine local Mintlify screenshots below were opened and visually inspected; an independent evidence check confirmed the passages match the final diff and found no source drift.
  • git diff --check, normal commit hook and pre-push gates passed: oxlint, both residual ESLint tasks, 27 fast typechecks and Knip. Initial dependency/download/native-binding failures were repaired in the sandbox; no hooks were bypassed or dependency files changed. Knip emitted an existing non-failing mint ignoreBinaries hint.
  • No live vendor authorization, paid inference, external sends, sandbox provisioning, production installation or upgrade/restore was performed. Complete API/permission, privacy, collector, scheduler and deployment-default verification remains outstanding as detailed in the ledger. The initial product services did not start after dependency setup failed; their journeys are not inferred from the working docs preview.

Checklist

  • The PR title follows the repo convention: [Fix], [Feat], [Improve], [Refactor], [Docs], or [Chore] followed by a user-facing description
  • This PR is small and scoped to one change
  • pnpm lint and pnpm check-types pass locally
    • Their normal fast pre-push gates passed; formatting-inclusive commands were not separately run for MDX-only changes.
  • I added tests or included a clear manual validation note above
  • I removed secrets, tokens, private keys, and customer data from code, logs, and screenshots
  • If this change should appear in the changelog, I ran pnpm changeset
    • Documentation-only corrections; no changeset needed.

Screenshots

Genuine local Mintlify rendering with no simulated state. These representative passages prove readable documentation appearance only, not live provider behavior, authorization, billing or delivery. Other edited pages, mobile and dark mode are not shown. Existing missing sidebar icons are tracked in #3594; weak lime navigation contrast is not changed here.

ChatGPT plan-limit troubleshooting and API routing precedence

Granola space API controls and administrator restriction

AgentMail free custom-domain and paid-plan guidance

@roomote-community

roomote-community Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor Author

No issues found in the nine changed documentation pages. Checked the revised setup, routing, and Z.AI guidance against source, and Granola and AgentMail claims against current official documentation. CI docs validation, lint, typecheck, and tests passed; some other checks were still running. See session

Reviewed 6db5667

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant