Skip to content

docs(readme): sell the speed and the 3-step setup, drop ADRs - #310

Merged
LouisHaftmann merged 2 commits into
devfrom
docs/readme-benchmarks-drop-adrs
Oct 28, 2026
Merged

LouisHaftmann merged 2 commits into
devfrom
docs/readme-benchmarks-drop-adrs

Conversation

@LouisHaftmann

Copy link
Copy Markdown
Collaborator

📝 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:

 # 🚀 GitHub Actions Cache Server
+One-paragraph pitch: actions/cache, setup-* caches and BuildKit type=gha, no workflow changes
+| Image 29 MB | Healthy in 0.5 s | Idle 3 MiB | Upload 2.3 GiB/s | First download 7.9 GiB/s | 34,000 lookups/s, p99 7 ms | 1,143 small save+restore/s |
 ## Features
+storage + database drivers, token verification and per-repository scopes, direct downloads,
+eviction and self-healing, metrics + management API, Helm, amd64/arm64, GHES
 ## Quick start
-compose file with every STORAGE_*/DB_* var
+1. compose file relying on the filesystem + SQLite defaults
+2. runner image ghcr.io/falcondev-oss/actions-runner + CUSTOM_ACTIONS_RESULTS_URL
+3. There is no step 3.

The ADR references in code comments are dropped, and docs/agents/domain.md no longer points agents at docs/adr/.

✅ Verification

  • cargo +nightly fmt --check and cargo clippy --all-targets --locked pass. The Rust changes are comments only, so cargo test was not run.
  • No ADR or docs/adr mention is left in the repo.
  • The quick start's defaults (STORAGE_DRIVER=filesystem, DB_DRIVER=sqlite, paths under .data/ in WORKDIR /app) match src/config.rs and the Dockerfile, so the /app/.data volume holds both.

💥 Merge danger

Door: two-way

Blast Radius: docs

⚠️ Needs attention

🤖 Generated with Claude Code

LouisHaftmann and others added 2 commits October 28, 2026 08:56
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>
@LouisHaftmann
LouisHaftmann merged commit 0a739b2 into dev Oct 28, 2026
27 checks passed
Sign up for free to 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