Skip to content

Reframe positioning: event layer for agents, not integration filesystem#331

Merged
khaliqgant merged 2 commits into
mainfrom
claude/solution-problem-fit-yfkt5j
Jun 23, 2026
Merged

Reframe positioning: event layer for agents, not integration filesystem#331
khaliqgant merged 2 commits into
mainfrom
claude/solution-problem-fit-yfkt5j

Conversation

@khaliqgant

@khaliqgant khaliqgant commented Jun 22, 2026

Copy link
Copy Markdown
Member

Summary

  • Lead with the reactive story, not the filesystem metaphor. The headline shifts from "The integration filesystem for agents" to "The event layer for AI agents" — the filesystem is the how, not the why. The real pain is normalizing N provider webhooks into one consistent format that agents can react to.

  • Reorder "Why files" to lead with reactive invocation. Context efficiency (the weakest pain point) was previously Make Relayfile completely provider-agnostic #1. Reactive invocation — provider webhooks normalize into file events that wake agents with zero parsing — is now Make Relayfile completely provider-agnostic #1.

  • Distinguish Relayfile from Mirage explicitly. Mirage is a pull/query layer (agents ask for data). Relayfile is a push/event layer (events reach agents). Complementary, not competing. The comparison now makes this clear rather than vaguely saying "different scopes."

  • Frame the daemon as an integration runtime, not overhead. The daemon keeps OAuth warm, absorbs rate limits, and deduplicates webhook deliveries before agents see them — same reason you run a database process. Hosted Agent Relay is surfaced immediately as the zero-infra alternative.

  • getting-started: hosted path first. Lowest-friction path (no infrastructure) leads; local OSS quickstart follows. Opening framing explains the event-normalization value before diving into setup steps.

Rationale

Compared Relayfile's positioning against Mirage (3.2k stars), which wins partly by leading with zero-new-vocabulary and clear category ownership. The key insight Relayfile has that Mirage doesn't: Mirage is query-time (agents pull), Relayfile is event-time (agents are invoked by normalized webhooks). That's the unclaimed category — and the one that matters most as agent systems move from sequential pipelines to reactive, event-driven architectures.

Test plan

  • Read through README.md cold — does the opening paragraph make the value clear without prior context?
  • Check that the Mirage comparison is fair and accurate
  • Verify the daemon framing section links correctly to the Hosted Agent Relay section
  • Read getting-started.md — does the hosted path feel like the natural first choice?

🤖 Generated with Claude Code

https://claude.ai/code/session_01PF9GK3mPDyWEKXpaJ8ReB9


Generated by Claude Code

Review in cubic

- Lead with the reactive/event-driven story: Relayfile normalizes SaaS
  webhooks and delivers them to agents, rather than leading with the
  filesystem metaphor which is the how, not the why
- Reorder "Why files" to lead with reactive invocation (#1) over context
  efficiency, which is the weaker pain point
- Explicitly distinguish Relayfile (event/push layer) from Mirage
  (query/pull layer) — complementary, not competing
- Frame the daemon as an integration runtime (keeps OAuth warm, absorbs
  rate limits, deduplicates webhook deliveries) not as infrastructure
  overhead; link hosted path as the zero-infra alternative
- getting-started: lead with hosted path (least friction) before local
  OSS quickstart; open with the event-normalization framing

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PF9GK3mPDyWEKXpaJ8ReB9
@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

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: 3f6c52e3-7e53-4832-b77b-66d7089f7099

📥 Commits

Reviewing files that changed from the base of the PR and between 29fdd06 and 15bcc38.

📒 Files selected for processing (1)
  • docs/guides/getting-started.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/guides/getting-started.md

📝 Walkthrough

Walkthrough

Documentation-only update to README.md and docs/guides/getting-started.md. The README reframes Relayfile as an "event layer" in the hero copy, restructures the "Why files" bullet list, and rewrites the Mirage comparison. The getting-started guide renames and relocates the hosted-provider section and removes a duplicate block.

Changes

Relayfile docs reframing

Layer / File(s) Summary
README messaging: event layer framing, Why files, and Mirage comparison
README.md
Hero text is replaced with "event layer" language; the Why files bullets reorder Reactive invocation and Coordination, drop completeness, and rewrite context efficiency around MCP tool-schema overhead; the Mirage comparison paragraph is expanded to enumerate Relayfile capabilities and contrast pull vs. event-driven models.
Getting-started guide: hosted-provider section restructure
docs/guides/getting-started.md
Opening paragraphs are replaced with webhook normalization/file-tree model copy and a renamed "Hosted Provider Files (Least Friction)" section; the duplicate earlier hosted-provider block is removed so the guide transitions directly into Fully Self-Hosted Provider Files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 A file tree blooms where webhooks land,
No parsing plumbing, all pre-planned.
"Event layer!" the README declares,
The getting-started guide repairs.
Less friction, more hops — what a plan!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: repositioning Relayfile from 'integration filesystem' to 'event layer,' which directly reflects the core messaging shift across both README.md and getting-started.md.
Description check ✅ Passed The description is directly related to the changeset, providing detailed context about the positioning shift, rationale for changes, and specific improvements to messaging strategy covered in both modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 claude/solution-problem-fit-yfkt5j

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@agent-relay-code

Copy link
Copy Markdown
Contributor

CI runs Go tests/build, SDK typecheck/test, E2E, and workers typecheck. There is no markdown lint or link-check job. This PR only changes two .md files (README.md and docs/guides/getting-started.md), which none of the CI jobs compile or import. The contract.yml check is about the OpenAPI ↔ server.go surface — untouched here.

My single edit is a Markdown anchor fix — it does not affect any Go, TypeScript, or build artifact. No CI job will exercise it, so there's nothing to build/test for verification beyond confirming the markdown is correct. The edit is a pure link-target correction and is verifiable by inspection: the heading ## Hosted Provider Files (Least Friction) produces the GitHub anchor #hosted-provider-files-least-friction, which now matches the link.

The change is safe to leave in the working tree.

Summary

PR #331 is a documentation-only change that reframes the project positioning from "the integration filesystem for agents" to "the event layer for AI agents." It rewrites the README intro, the "Why files" ordering, the Mirage comparison, the "Run Locally" preamble, and reorganizes docs/guides/getting-started.md (moving "Hosted Provider Files" to the top and renaming it).

Findings

1. Broken intra-doc anchor (fixed)docs/guides/getting-started.md:5
The PR added a link [Agent Relay Cloud](#hosted-provider-files) while renaming the target heading to ## Hosted Provider Files (Least Friction). GitHub generates the anchor #hosted-provider-files-least-friction from that heading, so the link was dead. Both the link and the renamed heading are new in this PR, so the breakage is self-contained. This is a mechanical, non-semantic link-target fix.

  • Fixed in docs/guides/getting-started.md:5

Verified correct (no change needed):

  • README.md:160 links [Hosted Agent Relay](#hosted-agent-relay) → resolves to the ## Hosted Agent Relay heading at README.md:292. Correct.

Advisory Notes

  • README.md:2 — the banner image alt text still reads "Relayfile — the integration filesystem for agents," which is now inconsistent with the new "event layer for AI agents" tagline on line 5. This line is not part of the PR diff and changing alt text isn't required to fix a demonstrated breakage, so I left it unchanged. A maintainer may want to update it for consistency in a follow-up.

Addressed comments

  • No bot or human review comments were present in .workforce/ (no comment threads in context.json, and no review files exist). Nothing to reconcile.

The PR is a clean docs change with one broken anchor that I corrected. No CI job compiles or imports these Markdown files (CI covers Go build/test, SDK typecheck/test, E2E, workers typecheck — none touch docs), so the edit cannot affect any build. This still needs a human to merge the positioning/messaging change, but I cannot confirm CI status or mergeability from here, so I am not printing READY.

@github-actions

Copy link
Copy Markdown

Relayfile Eval Review

Run: .relayfile/evals/runs/2026-06-22T22-18-23-526Z-HEAD-provider
Mode: provider
Git SHA: 3cdd209

Passed: 4 | Needs human: 0 | Reviewable: 0 | Missing output: 0 | Failed: 0 | Skipped: 0

Human Review Cases

No reviewable human-review cases captured Relayfile output.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/guides/getting-started.md`:
- Line 5: The anchor link [Agent Relay Cloud](`#hosted-provider-files`) in the
introductory paragraph does not match the actual heading that generates the
anchor. The heading "## Hosted Provider Files (Least Friction)" creates the
anchor `#hosted-provider-files-least-friction`, not `#hosted-provider-files`. Fix
this by either updating the link reference to match the full generated anchor
including the -least-friction suffix, or simplify the heading to "## Hosted
Provider Files" so it generates the expected `#hosted-provider-files` anchor that
the link targets.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5a61595d-4006-4c9f-b25e-ffe60e4da5aa

📥 Commits

Reviewing files that changed from the base of the PR and between 60d54c6 and 29fdd06.

📒 Files selected for processing (2)
  • README.md
  • docs/guides/getting-started.md

Comment thread docs/guides/getting-started.md Outdated
@agent-relay-code

Copy link
Copy Markdown
Contributor

Working tree is clean — I made no edits (correctly, since this is prose with no mechanical fixes needed).

Review Summary

PR #331 is a documentation-only change to two files: README.md and docs/guides/getting-started.md. It reframes the project positioning from "the integration filesystem for agents" to "the event layer for AI agents," restructures the "Why files" reasons, rewrites the Mirage comparison, and reorganizes the hosted-vs-local setup sections.

Verification performed:

  • Traced both new internal anchor links — both resolve correctly:
    • README.md:160[Hosted Agent Relay](#hosted-agent-relay) matches ## Hosted Agent Relay (README.md:292).
    • getting-started.md:5[Agent Relay Cloud](#hosted-provider-files-least-friction) matches ## Hosted Provider Files (Least Friction) (getting-started.md:9) under GitHub's anchor-generation rules (parentheses dropped, lowercased, spaces → hyphens).
  • Grepped the repo for the new anchors and the old (removed) ## Hosted Provider Files anchor — no stale/dangling references remain anywhere.
  • Confirmed no code, types, tests, config, or the OpenAPI contract are affected.
  • Inspected CI workflows (ci.yml, contract.yml, publish.yml, relayfile-evals.yml) — none lint or link-check markdown, so docs changes can't fail CI.

No edits made. The changes are prose-only with no lint/format/typo/import-order issues to mechanically fix, and the content is accurate and internally consistent. No semantic or safety-critical logic is involved.

Addressed comments

  • No bot or human review comments were present in .workforce/ (only pr.diff, changed-files.txt, and context.json; no comments file). Nothing to address.

Advisory Notes

  • None requiring action. The banner alt text in README.md:2 still reads "the integration filesystem for agents," which is now slightly inconsistent with the new "event layer" tagline. This is a cosmetic alt-text mismatch, not a defect; I'm flagging it rather than editing because the author's intent for the banner asset/alt text is a judgment call and outside the demonstrated scope of this prose reframing.

I am not printing READY: I cannot observe CI check status or GitHub mergeability from this sandbox (those are post-harness/cloud-reported), and the instructions require all required checks to be confirmed complete and passing plus a confirmed no-conflict state before signaling a human. The review itself is complete and the working tree is clean.

@khaliqgant khaliqgant merged commit 5a21847 into main Jun 23, 2026
9 checks passed
@khaliqgant khaliqgant deleted the claude/solution-problem-fit-yfkt5j branch June 23, 2026 10:55
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