Repository navigation
docs(readme): sell the speed and the 3-step setup, drop ADRs - #310
Merged
Merged
Conversation
Removes docs/adr and every reference to it from code comments and the agent domain docs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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
The README undersold the server: one line about speed, no numbers, and no word on how little it takes to get runners using it. The ADRs in
docs/adr/were also more noise than help, so they go.The README now opens with the benchmark numbers from #288, lists every feature, and shows the whole setup as three steps:
The ADR references in code comments are dropped, and
docs/agents/domain.mdno longer points agents atdocs/adr/.✅ Verification
cargo +nightly fmt --checkandcargo clippy --all-targets --lockedpass. The Rust changes are comments only, socargo testwas not run.ADRordocs/adrmention is left in the repo.STORAGE_DRIVER=filesystem,DB_DRIVER=sqlite, paths under.data/inWORKDIR /app) matchsrc/config.rsand theDockerfile, so the/app/.datavolume holds both.💥 Merge danger
Door: two-way
Blast Radius: docs
🤖 Generated with Claude Code