Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion apps/docs/automations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ deployment helper model to write a brief commit summary, and includes the pusher
and commit authors. Feature-branch pushes and branch deletions are ignored.
GitHub, GitLab, Azure DevOps, Bitbucket, and Gitea are supported.
For GitHub merge commits that Roomote can match to a pull request, the summary
uses that pull request's context and **View changes** opens the pull request.
uses that pull request's context, identifies the repository and pull request
number, and links **View changes** to the pull request.
When the pull request body contains a suitable image, the Slack announcement
can also show one representative screenshot after Roomote validates its URL and
image type. Announcements continue without an image when validation fails.
Expand Down
5 changes: 5 additions & 0 deletions apps/docs/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ This is intentional. It lets production operators keep secrets and platform
configuration in the deployment system while still letting admins manage
non-env settings in the app.

The generic **Deployment Environment Variables** editor also hides and rejects
Roomote-managed and control-plane keys. Configure provider-owned keys on their
provider Settings page instead; the generic editor cannot create, edit, or
delete them.

Use the UI when:

- the value is safe for an admin to rotate from Roomote
Expand Down
30 changes: 19 additions & 11 deletions apps/docs/fast-sessions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,25 @@ automations, and the web dashboard.
A Session can also run Roomote's structured code review on demand. Ask it to
review a pull request and the Review Code pipeline runs as a task inside the
Session; in a pull request discussion, it reviews that pull request.
Eligible automatic reviews of pull requests opened by Session tasks also appear
as tasks in the Session that opened the pull request.

When a task in a Session opens a pull request, that pull request belongs to the
Session. A mention on it joins the Session instead of starting a new one, and
Roomote answers on the pull request as well as in the Session's home surface.

## Start a Session from the dashboard

On the home page, leave the workspace selector on **Fast** to start a
conversation. Roomote answers directly when it can and delegates execution
when the request needs a repository workspace. Selecting an environment or
repository still starts a Session: the Session records your request, delegates
the task into that workspace right away without a model turn, and opens the
task workspace. You can return to the Session at any time to continue the
conversation around that task.
On the home page, enter a request to start a Fast Session. Roomote answers
directly when it can and delegates execution when the request needs a repository
workspace. Fast is also the default for unpinned requests from supported chat
providers.

Fast is the default for unpinned requests across the web dashboard and
supported chat providers. Choose an environment or repository explicitly when
you already know where the work should run.
After creating or editing an environment, choose **Use environment** to open an

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.

There is currently no Use environment action after creating or editing an environment. Creation redirects directly to /?environmentId=..., while editing returns to the environments list; onGoUseIt is not rendered by EditEnvironmentPage. This makes the new instructions here and in how-roomote-works.mdx impossible to follow. Document the actual redirect/launcher flow, or add the described action.

environment-pinned launcher. Submitting there still starts a Session, but it
delegates the task into that environment immediately and opens the task
workspace. You can return to the Session at any time to continue the
conversation around that task.

Select **New Session** in the navigation to open the same launcher from any
dashboard page.
Expand All @@ -56,7 +57,14 @@ task with documents created directly during the conversation, labels each item
by its Session or task source, and opens previews without leaving the Session.
Links to a Session-created artifact, including the link the Session shares when
it creates one, open that artifact directly in the Artifacts panel. Individual
task details continue to show their own artifacts.
task details continue to show their own artifacts. For a Markdown artifact,
choose **Build this** to send it back to its owning Session, where Fast can
discuss it or delegate its implementation.

The **Live Preview** panel combines active previews from every linked task. When
more than one task has a preview, service labels include the task name so you
can tell them apart. Previews disappear when their task finishes or its sandbox
goes to sleep; open the task workspace to wake a sleeping task.

**Session info** shows the total inference cost for the conversation and its
attached tasks. Open the cost breakdown to separate direct Session orchestration
Expand Down
10 changes: 6 additions & 4 deletions apps/docs/how-roomote-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,12 @@ gives a clear answer or next step without pretending code was changed.

In chat, Roomote's Fast Session decides whether a request needs a workspace
and which environment fits, and it says so before delegating. Reply in the
same thread to redirect it. When you start from the dashboard, choose the
environment yourself or leave the selector on **Fast** to let the Session
decide. A Linear agent session works the same way: the Session reads the
issue and chooses the environment before delegating.
same thread to redirect it. Requests from the dashboard home page also start a
Fast Session that chooses the environment before delegating. To launch directly
into a known environment, choose **Use environment** after creating or editing
it; the resulting pinned Session delegates there immediately. A Linear agent
session works the same way: the Session reads the issue and chooses the
environment before delegating.

If a request is ambiguous, the Session asks a clarifying question in the same
thread before it delegates, so you can name the environment or repository in
Expand Down
10 changes: 5 additions & 5 deletions apps/docs/models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -301,11 +301,11 @@ through its task-management tool, subject to the same allowed-models list.

Conversational Sessions expose the same model and reasoning choices in their
composer. New Sessions show the deployment's orchestration model by default;
direct environment and repository tasks show the coding model. Leaving the
Session selection untouched keeps deployment-default behavior, while an
explicit selection is saved before the next message can be sent, persists
across page refreshes, and applies to later Fast turns without changing a turn
that is already running.
environment-pinned launches show the coding model. Leaving the Session
selection untouched keeps deployment-default behavior, while an explicit
selection is saved before the next message can be sent, persists across page
refreshes, and applies to later Fast turns without changing a turn that is
already running.

## Fast delegation and consultation

Expand Down
5 changes: 5 additions & 0 deletions apps/docs/source-control.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ the same lines are already under discussion. On Gitea, that reply becomes a
pull request comment that references the original thread. Roomote can anchor
new findings to added, changed, or deleted lines.

When a Fast Session starts from an issue or pull request comment, its response
quotes the triggering comment. Each turn uses one Roomote comment and edits it
as additional replies arrive instead of stacking separate comments. The footer
links back to the Session and, when available, its live preview.

If a provider rejects an inline location, Roomote retries with the current diff
and then includes the finding with a file and line reference in the review
summary. On later sync reviews, Roomote resolves its inline thread when the
Expand Down
8 changes: 3 additions & 5 deletions apps/docs/tasks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,9 @@ detail to review the work. Presentational widgets remain available in the task
transcript; when an agent provides a text fallback, Roomote also sends that
fallback to the originating Slack, Teams, Telegram, or Discord conversation.

For a Markdown plan artifact, **Build this** starts a Session and delegates the
plan to a task inside it. Roomote preserves the selected environment, branch,
and model, and retries the same kickoff if the first launch is interrupted. Use
the confirmation link to follow the Session, then open the delegated task for
its operational details.
For a Markdown artifact, **Build this** sends the artifact to the existing
Session that owns it. Fast can discuss the artifact there or delegate its
implementation to a task.

Generated HTML artifacts open in a sandboxed **Preview** by default. Switch to
**Code** to inspect the saved HTML source without executing it in the page that
Expand Down
Loading