docs: plain-prose pass over README - #95
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prose pass over README.md, the only user-facing Markdown in this repo (no mkdocs site;
docs/holds ADRs and agent notes, which are out of scope). Code blocks, inline code, link targets and the pyproject description are unchanged.What changed
AsgiFastStreamnote, "Tuning", "Must be outermost", "Fix", "These raise...", "Still unguarded", and the two bold-led bullets under Limitations > Other). Rewritten as plain sentences.###subsections (Message dispatch, Concurrency control, Offset committing, Rebalance handling, Shutdown).Anchors
#how-it-works; it now points at the new#rebalance-handlingsubsection.#quick-start.Left on purpose
**not honoured**cells in the control-signals table: the following paragraph refers to the rows "marked not honoured", so the marking carries meaning.Verification
just lint-ci: passes.KAFKA_BOOTSTRAP_SERVERS=localhost:39192 uv run --no-sync pytest), container removed afterwards.