Repository navigation
Rewrite the quickstart in a plain, instructional voice - #149
Merged
Merged
Conversation
Cut the meta-opening, the design justifications, and the over-explained prose. Every sentence now does instruction. The code and the complete program are unchanged. Generated by Mistral Vibe. Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
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
1 participant
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.
What changed
Rewrote
docs/getting-started/quickstart.mdto follow the voice gradient in AGENTS.md: the funnel top is written plain, every sentence doing instruction.Cut:
Also corrected "same characters" to "same rolls" — the character name is caller-supplied, not drawn from the seed.
What didn't change
The code is untouched. The complete program at the end of the page is identical and still passes the doc-example test harness (linted + executed).
Verification
pytest tests/test_docs_examples.py— 319 passed, 73 skipped (no-run blocks)mkdocs build --strict— cleanmkdocs serveconfirmed the rewrite renders correctly