Uh oh!
There was an error while loading. Please reload this page.
docs(relayfile): agent brief as a markdown handoff, and provisioning vs the local mount - #62
Merged
Merged
Conversation
…provisioning from the mount Two problems with how the review-bot guide presented itself. The agent brief was a sidebar page. Its audience is an agent fetching the markdown mirror, not a human browsing docs, so a nav entry invited the wrong reading — that you go and read it. It is now unlisted: dropped from the sidebar, still built and indexed, and reached from a "Give your agent a guide for this" section at the end of the guide that hands over the one thing you actually do with it: curl -o AGENTS.md https://agentrelay.com/docs/file/markdown/review-bot-brief.md `ProductDocSection` gains `unlistedSlugs` for this: slugs that stay in getProductDocSlugs — which drives the page, og and markdown routes plus the search index — while staying out of the nav the sidebar renders. Step 1 conflated provisioning with the local mount. It read as "one command sets everything up, including a mount", so a reader building a cloud bot came away thinking the local mirror was load-bearing. It says now that `relayfile setup` is provisioning, done once by a human on a machine with a browser because the OAuth needs one; that the mirror it leaves is for inspecting the tree; and that a deployed bot mounts per run in step 5 or skips the mount entirely. It also explains why --local-dir is passed at all — --skip-mount still prompts (relayfile#461). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NVwyjaMnm1PTRC6m7oXHJV Session-Id: 13b5d5ea-39b6-42f3-86df-6d7bf3570e4b
Contributor
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 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. Comment |
Uh oh!
There was an error while loading. Please reload this page.
Contributor
Preview deployed!
This is a Cloudflare Workers preview version of this PR's build. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two fixes to how the review-bot guide presents itself, both from reading it as a user rather than as its author.
The agent brief was a sidebar page
Its audience is an agent fetching the
.mdmirror, not a human browsing docs — a nav entry invited the wrong reading. It's now unlisted: out of the sidebar, still built and indexed, and reached from a new closing section on the human page that hands over the one thing you actually do with it:ProductDocSectiongainsunlistedSlugsfor this. Those slugs stay ingetProductDocSlugs— which drives the page, og and markdown routes plus the scoped search index — while staying out of thenavthe sidebar renders. Tests cover both halves: not in the sidebar, still in the slug list that builds the.mdendpoint the guide links to.Step 1 conflated provisioning with the local mount
It read as "one command logs you in, creates the workspace, runs the OAuth, and mounts the result", so someone building a cloud bot came away thinking the local mirror was load-bearing. It isn't — it's an inspection surface.
Now it says:
relayfile setupis provisioning, done once by a human on a machine with a browser because the provider OAuth needs one; the mirror it leaves behind is for you tols/cat/grepand see what your agents will see; a deployed bot mounts per run in step 5 or skips the mount entirely. It also explains why--local-diris passed at all, which otherwise looks arbitrary:--skip-mountstill prompts for a directory (relayfile#461).Verified
relayfile setupnow completes end to end against production on a clean machine (exit 0, workspace ready → Nango connect session →Setup complete), following cloud#3336, so the guide's first step is true again.npm teststill cannot run in this environment; the test assertions were hand-checked against the same functions they call.🤖 Generated with Claude Code
https://claude.ai/code/session_01NVwyjaMnm1PTRC6m7oXHJV