Repository navigation
docs: rework README around agent setup and refresh the docs - #101
Conversation
…ures Co-authored-by: dash0-dev[bot] <257284812+dash0-dev[bot]@users.noreply.github.com>
Co-authored-by: dash0-dev[bot] <257284812+dash0-dev[bot]@users.noreply.github.com>
…ry docs Co-authored-by: dash0-dev[bot] <257284812+dash0-dev[bot]@users.noreply.github.com>
Co-authored-by: dash0-dev[bot] <257284812+dash0-dev[bot]@users.noreply.github.com>
✅ No issues foundRe-review of the 3-line fix in docs/cli.md. The rewritten claim holds against the source: the CLI exits before the app's watchers and timers start, and enable, install and mount hand work to launchd. Prior finding resolved. Checked: 1 of 1 changed file read · no possible issues found Progress: open review threads 1 → 0 across the last 2 reviews Review details
Found Quality — produced 0 → posted inline 0 · cleared 0 · carried forward 0 · deferred 0 · below-bar 0 Run incremental-quick · 3 lines in delta · tier quick · depth checkout Nothing to report — standards (skipped), optimality (skipped), measurability (skipped), severity, reach diagram (impact graph found no consumer or importer), 0 files skipped.
|
…I process Addresses the pr-reviewer bot's comment: #101 (comment) Refs: #101 Co-authored-by: dash0-dev[bot] <257284812+dash0-dev[bot]@users.noreply.github.com>
The README now shows a two-line request that covers rclone and SyncTray, and links to docs/agent-setup.md, which keeps the step-by-step prompt and shows how an agent creates the rclone remote. Co-authored-by: dash0-dev[bot] <257284812+dash0-dev[bot]@users.noreply.github.com>
|
Darkplane auto-approval is enabled for this repository (mode: Auto-approve). Trigger an evaluation for this pull request when it is ready: |
Summary
The README was a 600-line mix of pitch, reference, and troubleshooting, and it undersold the newest differentiator: SyncTray can be set up end-to-end by an AI agent through the
synctrayCLI and the file-backed config. This PR turns the README into a product page (189 lines) and moves the depth intodocs/, fixing stale facts along the way.Changes
docs/user-guide.md,docs/agent-setup.md(incl. ground rules to paste into AGENTS.md/CLAUDE.md),docs/cli.md(all 19 commands, output, exit codes),docs/configuration.md(every profile field and default),docs/troubleshooting.md, and adocs/README.mdindex.CODE_SIGNING_ALLOWED=NO; local-change sync debounce is 5 s, not 15 s (also in CLAUDE.md)..devbundle ids, a Testing section (--self-test, schema check), commit convention +/betareleases moved here, and the telemetry section rewritten (30 s delta export, 50+ instruments, privacy list matching the in-app sheet; it previously claimed profile names aren't sent).Follow-ups (not in this PR)
docs/assets/profile-stream.pngstill shows the old "Requires macFUSE" warning and the old cache path, so the README no longer uses it. New captures would help: the Finder "Available Offline" menu, Cache Only, and a short GIF of an agent running the setup..claude/rules/files.