All pull requests

docs: rewrite quickstart with batteries-included scenario#421

Opensara-lindqvistwants to merge 5 commits intomainfromdocs/quickstart-rewrite
SASara Lindqvistcommented 1d ago

Summary

docs: rewrite quickstart with batteries-included scenario — addresses the regression surfaced in praxis after the recent docs work landed on main.

Why

  • The previous behavior on main short-circuited the safe path under load; this PR restores the intended contract.
  • Adds a guard so the regression cannot resurface silently in staging.
  • Drive-by: removes dead-code call sites the linter was warning about.

Scope

  • Files touched: 8 across the core module + tests.
  • No public API change; ABI is preserved.
  • CI: pending, will rerun when reviewers ack.

Labels: documentation

SASara Lindqvistcommented 2d ago

LGTM modulo the comment I left on the changelog entry.

YUYuki Tanakacommented 2d ago

Smoke-tested under the load profile from last week's incident. No regressions.

YUYuki Tanakacommented 2d ago

Nice — pulled this locally and the burn-rate window now lines up with the SLO board. Approving once the snapshot tests catch up.

YUYuki Tanakacommented 1d ago

Could we add a regression test for the partial-bucket case? I'm happy to push it on top if you'd prefer.

YUYuki Tanakacommented 1d ago

Left a few small nits inline. Otherwise the shape is exactly what we discussed in the design doc.

Checks are pendingAwaiting external validation
No conflicts with base branchMerging can be performed automatically.
You can also merge this with the command line. View command line instructions.Still in progress? Convert to draft

Add a comment

M↓Markdown is supported