Skip to content

[Docs] Repair provider icons and stale setup guidance - #3594

Draft
roomote-community[bot] wants to merge 1 commit into
developfrom
fix/docs-comprehensive-audit-2rb0oknbh4bna
Draft

roomote-community[bot] wants to merge 1 commit into
developfrom
fix/docs-comprehensive-audit-2rb0oknbh4bna

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 comprehensive public-documentation audit; no linked 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

What changed

  • Repair broken provider/integration logos: use Iconify's documented slash-based SVG route in 33 page icons and the shared overview snippet. All 32 distinct repaired destinations now respond successfully.
  • Correct recommended-model deletion guidance, optional environment prerequisites for communications, and the current account/inference bootstrap followed by conversational setup.
  • Distinguish Docker's 2048-PID runtime default from Compose's explicit 512-PID default, explain the override, and correct local worker-archive recovery.
  • List the actual accepted default-sandbox environment values, place GitHub Projects in organization permissions, clarify manual CI triage's one-repository scope, and correct the custom MCP connection-option count.

Why this change was made

The audit read all 123 public MDX pages, including hidden installation guidance and every Cookbook recipe, against integration e12f1701 and shipped main/v1.19.3 b532d7eb. Their product/docs trees are identical; only CHANGELOG.md differs. The page-by-page coverage and claim-evidence report retains baseline hashes, source references, external evidence, pending findings, and verification limits.

Revalidated prior audit PRs #3468 and #3515: both remain open and unmerged. Their pending corrections and the optional-chat, source-control prerequisite, and historical ChatGPT redirect fixes in #3514, #3593, and #3466 are not duplicated. The old unreleased HAR/rotation caveats in #3515/#3548 no longer match the shipped baseline.

Impact

Documentation-only corrections across 39 files, mostly one-line icon URL repairs. Readers get working provider logos and setup/resource guidance aligned with current implementation. This is not a clean-corpus certification: known corrections remain pending in the PRs above, and exhaustive reading does not mean every vendor/account/UI claim was independently exercised end to end.

How it was tested

  • mise exec -- pnpm --filter @roomote/docs check passed on the baseline and final diff: repository-pinned Mintlify 4.2.650 validation followed by internal broken-link checking.
  • mise exec -- pnpm --filter @roomote/docs check-cookbook-index passed with seven recipes; no generated drift.
  • Supplementary inventory: 123 pages, 115 navigation page/root references, no missing targets/icons/local icon assets. One existing invalid routing fragment remains pending [Docs] Correct stale public setup and workflow guidance #3468; Mintlify's link check does not catch it.
  • External prose-link and frontmatter-asset sweep: 126/134 destinations reachable. Two Requesty 404s are pending [Docs] Correct stale public setup and workflow guidance #3468; six access/method/rate-limit responses remain unverified. All 32 corrected Iconify destinations pass. Reachability is not a soft-404, content, or fragment guarantee.
  • Actual Mintlify preview opened all seven prose-edited pages plus the integration overview. Two exact screenshots below were opened and visually inspected; independent proof review confirmed their limited claims. The existing preview needed one restart after CLI validation affected generated files. Delivery diff is byte-identical to the proof snapshot.
  • git diff --check and normal commit/push hooks passed: oxfmt, oxlint, web/worker residual ESLint, all 27 typecheck tasks, and Knip. Full Vitest and formatting-inclusive pnpm lint / pnpm check-types were not run for this docs-only diff.
  • No paid-provider inference, external OAuth/bot installation, sandbox-provider provisioning, production install/upgrade/restore, or exhaustive permission/recovery journeys. Rippling live documentation retrieval produced no usable content. Vendor quotas, account-specific model access and performance estimates remain limited as recorded in the evidence report.

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
  • 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

No changeset is needed for documentation-only corrections.

Screenshots

Genuine local Mintlify rendering, without mocks or simulated state. These demonstrate representative documentation appearance, not integration authorization or resource-limit enforcement. Other edited paragraphs, lower table rows, mobile layouts, and dark theme are not pictured.

Repaired integration-table logos and visible sidebar logos

Shows six integration-table logos and matching Asana, Better Stack, and Buildkite sidebar logos.

Docker runtime and Compose process-limit guidance

Shows the 2048-PID runtime default, supplied Compose 512-PID default, operator override, and repaired Docker sidebar icon.

@roomote-community

roomote-community Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor Author

1 issue outstanding. See session

Reviewed 9f7c10a

(icon?.startsWith('/')
? icon
: `https://api.iconify.design/simple-icons:${icon}.svg?color=currentColor`);
: `https://api.iconify.design/simple-icons/${icon}.svg?color=currentColor`);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] Update the dark-mode CSS selectors alongside the Iconify URLs. apps/docs/roomote.css:124 still applies filter: invert(1) only to URLs starting with https://api.iconify.design/simple-icons:. The new slash-based URLs no longer match, and currentColor inside an external SVG image defaults to black rather than inheriting the page text color. In the Mintlify preview, switching /integrations to Dark leaves the repaired table and sidebar logos black against the dark background (computed filter: none). Update the Iconify selectors in roomote.css to match the repaired URL prefix so both inline and frontmatter logos remain legible.

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