Skip to content

docs: cut the README back to what a user needs - #505

Merged
fjmorant merged 1 commit into
masterfrom
docs/readme-tone
Sep 27, 2026
Merged

fjmorant merged 1 commit into
masterfrom
docs/readme-tone

Conversation

@fjmorant

Copy link
Copy Markdown
Owner

The bare example

Gone, not reworded. The paragraph explained why there is no bare React Native example — which only makes sense to someone who knew there used to be two. The archived repository already points at the Expo one, so anyone arriving from an old link still lands somewhere useful.

NPM_TOKEN

Gone from Releasing. It is maintainer configuration, done once, and it does not belong in a file people read to find out how to use the library. What is left says how a release happens and nothing about how to set one up.

Tone pass on the rest

The sections I added over the last few days argued their own design decisions at the reader:

Two node types are exported, because a node on the way in and a node on the way out are not the same shape.

there is one list, not one per node, whatever the shape of the data. Nesting lists of the same orientation is the arrangement React Native warns against, where windowing cannot work correctly

That is deliberate. NestedRow indents by level * paddingLeftIncrement, so a 0 base would put top-level rows flush against the screen edge — changing the appearance of every app built on the documented pattern, for no functional gain. It is inherited from the synthetic root node the old recursive renderer wrapped data in, and it is kept on purpose rather than by accident.

That reasoning is real, but it belongs in the CHANGELOG, where it is already written, and in the commits that made the decisions. Someone reading the README wants to know that levels start at 1 and how to get a flush edge — three lines, not three paragraphs.

Same treatment for Performance, Types, Node identity, Reaching the list and Using another list: kept the facts and the tables, cut the justification and the "so X, which is what lets Y" chains.

Net

48 lines in, 91 out. No documented behaviour changed, no props or types removed from the reference, every table kept.

🤖 Generated with Claude Code

Drops the paragraph explaining why there is no bare React Native example. The
absence does not need defending to someone who never knew there were two, and
the archived repository points at the Expo one already.

Drops the NPM_TOKEN setup from the Releasing section. It is maintainer
configuration, done once, and it does not belong in a file people read to find
out how to use the library.

The rest is a tone pass. The sections added over the last few days argued their
own design decisions at the reader: why two node types exist, why nesting lists
is the arrangement React Native warns against, why levels start at 1 rather
than 0, why the merge order for listProps is what it is. That reasoning belongs
in the CHANGELOG, where it is already written down, and in the commits that
made the decisions. A README should say what the thing does and how to use it.

48 lines in, 91 out. No documented behaviour changed.
@fjmorant
fjmorant merged commit 5921b1f into master Sep 27, 2026
5 checks passed
@fjmorant
fjmorant deleted the docs/readme-tone branch September 27, 2026 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant