docs: tighten README and DESIGN prose - #13
Open
singhguri wants to merge 1 commit into
Open
Conversation
The maintainers invited a prose pass on the docs. This tightens the README intro (status section, feature bullets — including the run-on 'Built-in nodes' bullet with its typo) and fixes two awkward constructions in DESIGN.md. No technical content, links, or commands changed.
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 and why
The maintainers invited a prose pass on the docs ("They may sound a bit AI-generated in places... A PR that improves the writing is as welcome as one that fixes a bug."). This tightens the README intro and two awkward constructions in DESIGN.md. No technical content, links, or commands changed.
How
README.md: clean run-on "Main branch is inactive..." into a proper Status section with a Discord link; tighten the intro paragraphs ("Where are those primitives?" → "Those capabilities should be one line — but today they mean importing libraries and writing plumbing."); fix the run-on "Built-in nodes" bullet (grammar + "langauge" typo); trim "Nothing is bolted on." from "Two native views".DESIGN.md: fix comma splice in "Coordination, not replacement"; reword the "If it compiles" opener.Linked issue
N/A
Type of change