docs: expand relayfile usage examples

[khaliqgant]

Summary

• Keep the README improvements focused and short after review feedback
• Add a compact Quick paths section for hosted setup, local OSS, sandbox SDK, and programmatic agent usage
• Surface Vercel AI SDK, Claude Agent SDK, OpenAI Agents SDK, and custom harness usage without duplicating the detailed hosted/local/SDK sections already later in the README

Validation

• npx prettier --write README.md
• git diff --check

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 543cf615-9ec3-4693-8c38-5ea0cc96305c

📥 Commits

Reviewing files that changed from the base of the PR and between 42e0e3b and e912b4b.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

README.md adds a "Quick paths" section near the top with short entry points for: hosted integrations, local OSS demo flow, sandbox SDK mounting, and programmatic agent usage. It includes a TypeScript snippet showing RelayFileClient.readFile() usage and lists common workflows for cross-provider drilling and provider patching.

Changes

Documentation Quick Paths

Layer / File(s)	Summary
Quick paths README section README.md	Adds "Quick paths" section with onboarding routes (hosted, local OSS, sandbox SDK, programmatic agents), a TypeScript RelayFileClient.readFile() example, and common workflows list covering read/drill patterns and writeback via canonical provider paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• AgentWorkforce/relayfile#111: Both PRs are README-only updates adjusting quickstart and quick paths mounting guidance around Relayfile/RelayFileClient usage.
• AgentWorkforce/relayfile#123: Both PRs update README.md to document sandbox/workspace mounting via the TypeScript SDK, specifically covering RelayfileSetup.ensureMountedWorkspace().

Poem

🐰 Quick paths bloom bright for all to see,
Where SDK mounts and examples roam free,
From sandbox to agent, a guided delight—
The README now shines with clarity's light!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: expand relayfile usage examples' accurately describes the main change, which is adding a Quick paths section with usage examples to the README.
Description check	✅ Passed	The description clearly explains the changes: adding a focused Quick paths section with concise entry points for different usage patterns, supported by validation steps.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/relayfile-readme-examples

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 3 additional findings.