Repository navigation
docs: plain up prose in README, guides, CONTEXT and AGENTS - #108
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-only edit of the README, the docs pages,
CONTEXT.mdandAGENTS.mdto remove AI-writing tells. No facts, option names, defaults, numbers or link targets change, and no code blocks were touched.Most of the change replaces em dashes with a colon, semicolon, comma or a new sentence, depending on how the clauses relate. Other edits:
redis-cli" now says plainly that those are the keys to look up there.CONTEXT.md: dropped "and the difference matters" from the Topic entry, and split the Schedule entry so the reason for thepublish()name is one sentence and the domain verb is another.docs/index.mdanddocs/usage/subscriber.mdeach had one dash and got the same treatment, to stay consistent with the README.Left alone on purpose:
basic.mdandpublisher.md(code).—in themessagerow of the publisher options table, which marks an empty default.~3–5×range in thelease_ttlrow ofhow-it-works.md.CONTEXT.mdthat carry information ("not the message it carries", "rather than exactly-once", "A Claim is not a lock").mkdocs build --strictpasses.