Skip to content

docs(demo): document BURST mode in the quickstart - #811

Merged
behinddwalls merged 1 commit into
mainfrom
preetam/docs-demo-burst
Oct 7, 2026
Merged

behinddwalls merged 1 commit into
mainfrom
preetam/docs-demo-burst

Conversation

@behinddwalls

@behinddwalls behinddwalls commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Why?

make demo-requests BURST=true (create every change, then enqueue them together) works and is tested, but the quickstart's option list skipped it, so it was only discoverable from make help or the Makefile.

What?

  • Add BURST=true to the demo-requests options list in doc/howto/QUICKSTART.md.
  • Add a paragraph on what burst does and how to get a true spike (COUNT=100 BURST=true CONCURRENCY=100), since enqueues are still bounded by CONCURRENCY; notes GitHub rate limits and that it doesn't apply with STACKED or LAND=false.

Test Plan

✅ make lint-fmt (lint-message-id fails locally on an untracked pkg/mod/ module cache, unrelated)
✅ Behavior checked against service/submitqueue/demo/run.go (createAndSubmit, forEachChange)

🤖 Generated with Claude Code

## Summary

### Why?

`make demo-requests BURST=true` (create every change, then enqueue them together) works and is tested, but the quickstart's option list skipped it, so it was only discoverable from `make help` or the Makefile.

### What?

- Add `BURST=true` to the `demo-requests` options list in `doc/howto/QUICKSTART.md`.
- Add a paragraph on what burst does and how to get a true spike (`COUNT=100 BURST=true CONCURRENCY=100`), since enqueues are still bounded by `CONCURRENCY`; notes GitHub rate limits and that it doesn't apply with `STACKED` or `LAND=false`.

## Test Plan

✅ `make lint-fmt` (`lint-message-id` fails locally on an untracked `pkg/mod/` module cache, unrelated)
✅ Behavior checked against `service/submitqueue/demo/run.go` (`createAndSubmit`, `forEachChange`)
@behinddwalls
behinddwalls marked this pull request as ready for review October 7, 2026 21:40
@behinddwalls
behinddwalls requested review from a team and sbalabanov as code owners October 7, 2026 21:40
@behinddwalls
behinddwalls force-pushed the preetam/docs-demo-burst branch from 6e54132 to 4d0c3ae Compare October 7, 2026 21:41
@behinddwalls
behinddwalls enabled auto-merge October 7, 2026 21:41
@behinddwalls
behinddwalls added this pull request to the merge queue Oct 7, 2026
Merged via the queue into main with commit 1cf2bb4 Oct 7, 2026
16 checks passed
@behinddwalls
behinddwalls deleted the preetam/docs-demo-burst branch October 7, 2026 22:25

This branch was previously deployed

1 inactive deployment
stack-rebase — 4d0c3aec Deployed Oct 7, 2026 by behinddwalls via Rebase Stack #586
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.

2 participants