Skip to content

docs: retire algo-review.md into quality.md - #265

Merged
reardencode merged 1 commit into
masterfrom
docs/retire-algo-review
Aug 26, 2026
Merged

docs: retire algo-review.md into quality.md#265
reardencode merged 1 commit into
masterfrom
docs/retire-algo-review

Conversation

@rearden-grok

@rearden-grok rearden-grok Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Delete docs/algo-review.md. It was a second backlog (inventory + gotchas + micro-opts + a Closed-shaped dump) next to the living Open list.
  • File the leftovers that are actually worth doing as Q-57–Q-60 in docs/quality.md, ranked above blocked/lint work:
    • Q-57 store publish / Class C flush / sidecar (seqlock fences, lost dirty flush, fuse8 OOB, spender cycle, sidecar fsync, runs_io)
    • Q-58 mempool persist order + eviction (body-before-LIVE, out-of-range vout, rate-tie strand, evict_to_budget spin)
    • Q-59 RPC/CLI honesty (submitblock vs docs, gettxout include_mempool, ignored maxfeerate/maxburnamount, conf milestone=0, --minrelaytxfee, blockmintxfee, getnetworkhashps, unbounded JSON-RPC batch)
    • Q-60 P2P caps + compact reconstruction (prefilled indexes, AddrMan, cmpct_fills, announced_wtx, FIFO eviction, Esplora WS off tokio, IBD disconnect_to skip)
  • Won't-fix the rest: package-level feerate (COMPAT), Esplora /blocks reconstruct + chained mempool stats, and the micro-opt list (reopen a named Q-id only with a mainnet profile).
  • Map / CHANGELOG / AGENTS.md stop pointing at the deleted file. Do not resurrect docs/algo-review.md.

Not copied

Crate inventory, “checked and found sound,” gotchas that already live in owner docs (invariants.md, COMPAT, SCHEMA), and High-empty / work-order prose.

Other docs that look ripe (not this PR)

  • docs/errata.md — one fact (leftover maps txid → one fk). Already stated in invariants.md leftover union and in quality.md Won't-fix. Fold into invariants.md and delete.
  • docs/peer-clients.md — same shape as algo-review (dated snapshot, ranked later-consideration, “do not copy into quality.md”). Highest steal is already Q-30. Keep until ranks 2–5 are promoted or won't-fixed; then the comparison can live as a short pointer in architecture.md.
  • Not ripe: mempool-fee-estimation.md (owns the 10-minute inclusion product), experimental-mainnet.md (0.5 runbook), rust-bitcoin-limitations.md, env-knobs.md, road-to-1.0.md.

Test plan

  • Docs-only; no production change
  • Required Actions green (fmt, deny, clippy, ast-grep, test, windows, macos, multinode, coverage)

Made with Cursor

Worth-fixing leftovers are Q-57–Q-60 (store publish/flush, mempool
persist/eviction, RPC/CLI honesty, P2P caps). Inventory, gotchas, and
micro-opts are not a second backlog.

Co-authored-by: Cursor <cursoragent@cursor.com>
@reardencode
reardencode merged commit f525b22 into master Aug 26, 2026
13 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