Skip to content

docs(agents): E2B/Daytona sandboxes, fleshed-out examples, design patterns first - #115

Merged
eersnington merged 1 commit into
mainfrom
docs/agents-polish
Oct 2, 2026
Merged

eersnington merged 1 commit into
mainfrom
docs/agents-polish

Conversation

@eersnington

Copy link
Copy Markdown
Member

Polishes the Agents docs (agents/ only).

Sandboxes

  • Examples use E2B, with Daytona as an alternative. The agentOS provider ships later, so it's no longer mentioned.
  • The Quickstart shows e2b.ts and daytona.ts side by side.

Structure

  • Core order: Design Patterns, LLM API Keys, Sandboxes, Custom Tools, Session Lifecycle. "Next" links follow it, and the Quickstart and Pi pages point to Design Patterns.
  • The Overview has Quickstart and Pi cards at the top and a Concepts section. Pi is badged Beta.

Examples

  • Each design pattern is a complete server and client example. Patterns are keyed per user, Slack thread, or GitHub issue, and subagents are support specialists with their own tools.
  • Concept pages gain client files.
  • The models are mixed: Opus 5.5 by default, with Haiku, Sonnet, and GPT-5.x for narrow jobs.
  • Prompts work in an empty sandbox.
  • Connectors queue mentions so none are dropped mid-run.
  • Fixes: PR checkout, the apiKeys empty-string fallback, the reviewer's missing repo, and the auth placeholder comment.

Writing

  • Removed bloat.
  • No sentences start with code.
  • Diagrams redrawn: sandboxes, human in the loop, custom tools, and keys.

@railway-app

railway-app Bot commented Oct 2, 2026

Copy link
Copy Markdown

This PR was not deployed automatically as @eersnington does not have access to the Railway project.

In order to get automatic PR deploys, please add @eersnington to your workspace on Railway.

@eersnington
eersnington merged commit f72b3da into main Oct 2, 2026
2 of 3 checks passed
@eersnington
eersnington deleted the docs/agents-polish branch October 2, 2026 12:39

@the-company-company the-company-company Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟠 1 medium · 🔵 2 low

Reviewed commit d6dcb28.

Comment on lines +25 to +26
c.log.error({ msg: "reply failed", error });
} finally {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟠 Medium · Failed replies are permanently discarded

Any failure from prompt, getLastAssistantText, or postReply is caught, after which finally removes the comment from durable state and the action returns successfully. A transient model/provider/GitHub failure therefore produces no reply and can never be retried. The same drain implementation appears in the Discord, Linear, and Slack examples. Only dequeue after postReply succeeds; on failure, retain the head item and rethrow or schedule an explicit bounded retry/backoff.

</div>

<CodeSnippet file="examples/design-patterns/agent-per-key.ts" title="keys.ts" />
<CodeGroup>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Low · Multi-file examples bypass the workspace contract

This new group spans related server.ts and client.ts modules but omits workspace, contrary to the repository's required multi-file-example convention. The other groups added on this page, plus the new/expanded groups in agent-to-agent, quickstart, schedules, subagents, user-subscriptions, and workflows, do the same. Mark these as <CodeGroup workspace> so the files are treated and checked as one compilable example.

"adHocServices": {
"rivet-website": {
"name": "rivet-website",
"command": "cd /home/user/workspace/repos/website && ./node_modules/.bin/tsx scripts/assemble.ts && ./node_modules/.bin/tsx scripts/generate-markdown.ts && ./node_modules/.bin/astro dev --host 0.0.0.0 --port 4321",

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Low · Local portal state is committed as documentation

This generated editor/runtime metadata hard-codes one developer's /home/user/workspace/repos/website checkout and transient port 31227; it is not portable project configuration and sits inside the published docs source tree. Remove both .amp/portals files and ignore this local state so another portal run cannot reintroduce it.

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