docs(readme): drop hardcoded mount path from pitch + update skill link#111
Merged
Conversation
The mount can live anywhere via the SDK / CLI / FUSE layer, so the lead shouldn't pin it to ~/relayfile-mount. Generalizes the hero example to mount/ and adds one line about the choice being the user's. Updates the hosted-setup section to point at the published skill on main instead of the now-merged PR. - Hero: replace ~/relayfile-mount/* with mount/* throughout the example block; add explicit "the mount can live anywhere" callout. - Comparison: drop the parenthetical "under ~/relayfile-mount" from the Mirage paragraph for the same reason. - Hosted: skill link now points at https://github.com/AgentWorkforce/skills/blob/main/skills/setting-up-relayfile/SKILL.md instead of the PR. Existing "Run Locally" / "Local Dev" sections keep their ./relayfile-mount references — those are concrete --local-dir argument examples, not pitch text claiming a canonical path. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME documentation updated to standardize mount path examples from a specific home directory mount ( ChangesDocumentation Path and Reference Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Two small follow-ups to the README polish in #110 (which has already merged into main):
~/relayfile-mountfrom the pitch. The mount can live anywhere — the SDK, CLI, and FUSE layer all let the caller choose. The hero example now usesmount/as a generic relative path, with one line saying the location is the user's choice. Same change to the Mirage comparison paragraph.setting-up-relayfileskill link from the (now-merged) PR to the published skill on main: https://github.com/AgentWorkforce/skills/blob/main/skills/setting-up-relayfile/SKILL.mdWhat's intentionally unchanged
The "Run Locally", "Local Development Without Docker", and "Hosted Agent Relay" sections still reference
./relayfile-mountbecause those are concrete--local-dirargument examples in real shell invocations, not pitch text. They show users exactly what to type for the documented quickstart.Test plan
mount/reads naturally without sounding like a placeholder slot.🤖 Generated with Claude Code