Skip to content

[Docs] Correct public documentation inaccuracies - #1188

Draft
roomote-community[bot] wants to merge 2 commits into
developfrom
fix/documentation-accuracy-audit-0kw6gpvuydu7e
Draft

[Docs] Correct public documentation inaccuracies#1188
roomote-community[bot] wants to merge 2 commits into
developfrom
fix/documentation-accuracy-audit-0kw6gpvuydu7e

Conversation

@roomote-community

@roomote-community roomote-community Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Created by Roomote. Follow up by mentioning @roomote, in the web UI, or in Discord.

What changed

  • Correct sandbox-provider documentation for Roomote Cloud and Docker fallback selection.
  • Align Azure DevOps and Microsoft Teams setup instructions with the permissions, settings paths, and generated manifest used by the application.
  • Clarify analytics billing telemetry and the read-only or restricted capabilities of the Asana and Resend integrations.
  • Fix the CI failure triage recipe's step numbering.

Why this change was made

A page-by-page accuracy audit found several claims that had drifted from current implementation and product behavior. These focused corrections keep setup and capability guidance from sending operators down invalid or incomplete paths.

Impact

Public documentation now reflects the current provider catalog, configuration behavior, permissions, UI navigation, integration boundaries, and telemetry behavior. No application behavior changes.

@roomote-community

roomote-community Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor Author

1 issue outstanding. See task

  • apps/docs/environment-variables.mdx:224 documents blaxel for DEFAULT_COMPUTE_PROVIDER, but the runtime schema rejects that value.
  • apps/docs/anonymous-analytics.mdx:58 says licensed deployments send a license ID, but licensed-usage requests authenticate with the deployment license key instead.

Reviewed 7da0f06

Comment thread apps/docs/environment-variables.mdx Outdated
leave your servers.
analytics code runs in the browser and no anonymous usage events or daily
analytics reports leave your servers. Licensed deployments still report the
license ID and registered-user count used for subscription billing.

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.

This understates what the billing path sends. The separate licensed-usage sync authenticates its request with the deployment's license key in the Authorization header (packages/telemetry/src/server/license-cloud.ts), rather than reporting a license ID. Please describe this as a separate license-usage report authenticated by the license key, or otherwise document the actual identifier accurately.

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.

2 participants