docs(python): tighten the Python guide (house-style)#61
Merged
Conversation
Soul/house-style review (post-#59): - drop the decorative architecture ASCII diagram (the intro already states the flow: issue a token, sign streams, POST broadcasts; AnyCable owns the socket) - drop the meta '## Verified behavior' section (docs shouldn't narrate their QA) - add a 'That's it.' payoff after the broadcast step No content/accuracy change; tightens the guide toward the house style.
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.
Small cleanup from the soul/house-style review of the merged docs.
The Python guide carried two of the AI-shaped tells we're removing across the docs:
## Verified behaviorsection — docs shouldn't narrate their own QA ("every step here is exercised against a running server…"); that belongs in a PR, not the page. Removed.No content or accuracy change. forspell/markdownlint clean, build passes.
The front-door pages (
overview,quickstart,capabilities,editions) hold up under the same lens and are left as-is; the use-case guides (the real soul problem) are being reworked separately.