Skip to content

docs(relayfile): agent brief as a markdown handoff, and provisioning vs the local mount - #62

Merged
kjgbot merged 1 commit into
mainfrom
docs/agent-brief-as-markdown-link
Sep 4, 2026
Merged

docs(relayfile): agent brief as a markdown handoff, and provisioning vs the local mount#62
kjgbot merged 1 commit into
mainfrom
docs/agent-brief-as-markdown-link

Conversation

@kjgbot

Copy link
Copy Markdown
Contributor

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 .md mirror, 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:

curl -o AGENTS.md https://agentrelay.com/docs/file/markdown/review-bot-brief.md

ProductDocSection gains unlistedSlugs for this. Those slugs stay in getProductDocSlugs — which drives the page, og and markdown routes plus the scoped search index — while staying out of the nav the sidebar renders. Tests cover both halves: not in the sidebar, still in the slug list that builds the .md endpoint 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 setup is 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 to ls/cat/grep and 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-dir is passed at all, which otherwise looks arbitrary: --skip-mount still prompts for a directory (relayfile#461).

Verified

relayfile setup now 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 test still 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

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

Copy link
Copy Markdown
Contributor

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 4aff7609-4c48-4045-905f-8d1559189998


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.

@kjgbot
kjgbot merged commit c35975c into mainSep 4, 2026
3 checks passed
@kjgbot
kjgbot deleted the docs/agent-brief-as-markdown-link branch September 4, 2026 20:49
@github-actions

Copy link
Copy Markdown
Contributor

Preview deployed!

EnvironmentURL
Webhttps://b5999829-agentrelay-web.agent-workforce.workers.dev

This is a Cloudflare Workers preview version of this PR's build.

Sign up for freeto 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

@kjgbot