Skip to content

docs: launch-prep — comparison FAQ, benchmarks, AUR packaging, contributor onboarding - #74

Merged
martinus merged 1 commit into
masterfrom
docs-launch-prep
Jul 19, 2026
Merged

docs: launch-prep — comparison FAQ, benchmarks, AUR packaging, contributor onboarding#74
martinus merged 1 commit into
masterfrom
docs-launch-prep

Conversation

@martinus

Copy link
Copy Markdown
Owner

Groundwork so the repo is ready for a marketing push. Docs, packaging and metadata only — no code changes.

What's here

  • README + man page — "How it compares": bees vs ZFS dedup vs upstream duperemove, the question that leads every btrfs-dedup thread. The attribution paragraph now sits the byte-verifying FIDEDUPERANGE safety guarantee right next to the "developed with AI tooling" line.
  • docs/benchmarks.md: the exact tree, cold-vs-warm commands and duperemove 0.15.2 comparison behind the ~7× / 294→188 s numbers, linked from the README so the claims are reproducible.
  • packaging/aur/: in-tree PKGBUILDs for oans (release, checksummed against v1.2.0) and oans-git (VCS), each provides/conflicts the duperemove package. README covers publishing to the AUR.
  • CONTRIBUTING.md + issue templates: bug/feature YAML forms + Discussions/NAS-guide contact links, for when traffic arrives.
  • .gitignore: anchored the built-binary rules to root (/oans, /duperemove) — the unanchored oans rule was silently ignoring the new packaging/aur/oans/ directory.

Also done outside this PR

  • Added repo discovery topics: nas, homelab, selfhosted, storage, linux.

Still needs a human (can't do from here)

  • Publish the AUR package (needs your AUR account/SSH key — see packaging/aur/README.md).
  • Record an asciinema/GIF of a real run for the README.
  • Set a custom social preview image.
  • XFS: CI only exercises btrfs; the tests are fs-adaptive with explicit XFS handling, so support is real but not CI-proven — worth a manual oans -dr smoke on a real XFS reflink fs before launch.

🤖 Generated with Claude Code

…arding

Groundwork for the upcoming launch push:

- README + man page: add a "How it compares" section (bees / ZFS dedup /
  duperemove) — the #1 question on any btrfs-dedup thread — and sit the
  byte-verified-kernel safety guarantee next to the AI-assisted attribution.
- docs/benchmarks.md: document the exact tree, cold-vs-warm commands and the
  duperemove 0.15.2 comparison behind the headline numbers; link it from README.
- packaging/aur: in-tree PKGBUILDs for `oans` (release) and `oans-git`, each
  provides/conflicts `duperemove`, with a publishing README.
- CONTRIBUTING.md + GitHub issue templates (bug/feature forms + contact links)
  for when the traffic arrives.
- .gitignore: anchor the built-binary rules to root (/oans, /duperemove) so the
  packaging/aur/oans/ directory is no longer ignored.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@martinus
martinus merged commit 8afe7a1 into master Jul 19, 2026
2 checks passed
@martinus
martinus deleted the docs-launch-prep branch July 19, 2026 08:36
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