Skip to content

[Docs] Correct public documentation inaccuracies #1188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
roomote-community wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

[Docs] Correct public documentation inaccuracies #1188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0add517
docs: correct public documentation inaccuracies
roomote Aug 9, 2026
7da0f06
docs: omit disabled Blaxel default
mrubens Aug 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions apps/docs/anonymous-analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ Anonymous telemetry is opt-out:
- afterwards, admins can change it any time in **Settings > Deployment**

The setting applies to everyone in the deployment. When disabled, no
analytics code runs in the browser and no usage events or daily reports
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.

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

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.


## Roomote Cloud Specifics

Expand Down
13 changes: 8 additions & 5 deletions apps/docs/compute.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ You configure sandbox providers during setup and can change them later from

## Supported providers

Roomote supports local and hosted sandbox backends:
Roomote supports local and hosted sandbox backends. Roomote Cloud deployments
use a deployment-managed backend that requires no sandbox-provider setup and is
not shown in **Settings > Sandboxes**.

| Provider | Best for | Notes |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------- |
Expand All @@ -46,10 +48,11 @@ Roomote supports local and hosted sandbox backends:
| <IntegrationName href="/providers/compute/blaxel" icon="blaxel" name="Blaxel" /> | Hosted perpetual task sandboxes | Uses automatic standby for resumable tasks. |
| <IntegrationName href="/providers/compute/azure" icon="azure" name="Azure" /> | Hosted task sandboxes on Azure Container Apps (preview) | Supports memory+disk snapshots and sub-second standby resume. |

Docker is the default because it works well for local development and simple
self-hosted deployments. Hosted providers are useful when you want task work to
run away from the Roomote server, scale beyond one host, or use provider-managed
sandbox infrastructure.
Docker is the fallback default when no hosted provider is configured because it
works well for local development and simple self-hosted deployments. Managed or
preconfigured deployments may select another provider. Hosted providers are
useful when you want task work to run away from the Roomote server, scale beyond
one host, or use provider-managed sandbox infrastructure.

For resumable Docker tasks, Roomote retains the stopped container and writable
workspace so a follow-up can restart in place on the same host.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/cookbook/ci-failure-auto-fix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ clear instructions.
1. Set the Manager Channel under **Settings > Automations > Automation output**.
2. Enable **CI Failure Triage**.
3. Confirm each repository you care about belongs to a configured environment.
5. Use **Run now** to test the configuration, or wait for the next default-branch failure.
4. Use **Run now** to test the configuration, or wait for the next default-branch failure.

## Variations

Expand Down
3 changes: 2 additions & 1 deletion apps/docs/integrations/asana.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ icon: 'https://api.iconify.design/simple-icons:asana.svg?color=currentColor'
---

Connect Asana when your team plans or tracks work there and you want Roomote to
inspect projects, tasks, teams, and comments during a task.
inspect workspaces, projects, tasks, teams, comments, and users during a task.
The built-in Asana tools are read-only.

## When to use it

Expand Down
4 changes: 2 additions & 2 deletions apps/docs/integrations/resend.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ connection is shared across the deployment and requests Resend's

## Safer defaults

Roomote initially disables tools that send or reschedule email, create or
Roomote initially disables tools that send or update scheduled email, create or
remove API credentials, mutate domains or webhooks, mutate or trigger
automations, and mutate contacts. Read operations remain available, and
canceling a pending scheduled email remains enabled as a safety action.

The disabled tools include:

- single, batch, and broadcast sending
- rescheduling a scheduled email
- updating a scheduled email
- creating or removing API keys that could bypass Roomote's tool policy
- creating or updating automations, or sending events that trigger them
- updating or removing domains
Expand Down
13 changes: 8 additions & 5 deletions apps/docs/providers/communications/microsoft-teams.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ has a different bot app ID from the Entra app ID, choose **Show advanced config*
after the Directory (Tenant) ID field during setup and enter the bot-specific
values there.

After Microsoft sign-in, **Settings > Linked Accounts** shows the Microsoft
Teams account. Users who signed in with another provider can link Microsoft
from that settings page.
After Microsoft sign-in, **Settings > Personal > Linked Accounts** shows the
Microsoft Teams account. Users who signed in with another provider can link
Microsoft from that settings page.

## Teams bot registration

Expand Down Expand Up @@ -104,8 +104,11 @@ readiness, and enables all three messaging scopes:
- **Group chat** - group-chat messages that mention the bot start tasks

If you prefer to build the app package yourself in the Developer Portal, add a
bot capability that uses the same Microsoft App ID as `R_TEAMS_BOT_APP_ID` and
include the bot entry in the manifest:
bot capability that uses the same Microsoft App ID as `R_TEAMS_BOT_APP_ID`.
The relevant manifest sections are shown below; a complete uploadable manifest
also requires the app ID, version, developer, name, description, icons, and web
application metadata that the Developer Portal collects, plus the `identity`
and `messageTeamMembers` permissions used by Roomote:

```json
{
Expand Down
7 changes: 4 additions & 3 deletions apps/docs/providers/source-control/azure-devops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,10 @@ Source Control.

#### Required API permissions

Azure DevOps does not use Microsoft Entra application permissions for service
principals. Add the service principal to the Azure DevOps organization, assign
at least **Basic** access, and grant the required project and repository
In the app registration, add the Azure DevOps API permissions **Code, Graph,
and User Delegation / Impersonation**, save them, and grant admin consent for
the tenant. Then add the service principal to the Azure DevOps organization,
assign at least **Basic** access, and grant the required project and repository
permissions in Azure DevOps.

### Connect with your Microsoft account
Expand Down
Loading