Repository navigation
Rewrite sessions-commands-events in a direct, guide-appropriate voice - #152
Merged
Merged
Conversation
Prose-only pass over docs/guides/sessions-commands-events.md: cut AI-voice tells (design justifications, over-explained restatements, hedging, the coined "validate-then-mutate" label, "total and pure") while keeping the guide-interior register. No code block changed; every fenced block is byte-identical to HEAD. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
Second pass on docs/guides/sessions-commands-events.md, focused on
concision without changing technical meaning: merged sentences that
restated the same fact, cut flabby constructions, and dropped one
numeric surface count ("seven referee commands") per AGENTS.md's
no-counts-in-prose convention. Prose only; every fenced block remains
byte-identical to origin/main.
Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
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.
Two prose-only passes over
docs/guides/sessions-commands-events.md. No code block changed: every fenced block is byte-identical tomain(verified by diffing extracted fences against origin/main).Pass 1 — voice rewrite (declaw)
Cut the AI-voice tells while keeping the guide-interior register:
Kept as deliberate terminology: headings and anchors, the quoted example questions ("why did the party get that item?", "has this session ended?"), exactly one entrance,
spawnas the name of the command family.Pass 2 — concision (subagent pass, reviewed)
Merged sentences that restated the same fact (the "exactly one way to mutate" guarantee, the untouched-session/only-clears-every-check pair, "a lost battle is not the only way" into the
game_oversentence) and cut flabby constructions ("previously-dumped", "what the visibility field means", "for how you author", double "with... with the clock"). No fact added, dropped, or altered; all API names, codes, links, and anchors intact.One deviation from the pass brief, flagged for review: "seven referee commands" became "a family of referee commands" — AGENTS.md forbids numeric surface counts in prose, and the sibling listeners-and-flags page states the same partition without a total. The count is derivable from the "Three of them... the other four" partition that follows.
Verification
uv run pytest tests/test_docs_examples.py— 319 passed, 73 skipped (no-run blocks)uv run mkdocs build --strict— cleanReview locally at http://127.0.0.1:8001/osrlib-python/guides/sessions-commands-events/ (mkdocs serve with livereload is running).