docs: update README and add a table of contents - #54
Merged
Conversation
Search matches the ascii name and the country code as well, and has since the country-code fix; the Capital column renders but is deliberately not searched, which the README never said. Only the first/previous/next/last controls hide at one page, not the page size select. Getting started never named the Node 24 requirement that engine-strict turns into a hard install failure, and used npm install where the committed lockfile wants npm ci. The lint row omitted Stylelint and the zero-warning gate, and the stack list omitted Sass, Stylelint, and axe-core.
funkadelic
changed the title
funkadelic
marked this pull request as ready for review
August 28, 2026 06:19
The opening line now describes the app in the terms the rest of the repository already uses for it. The notes section now opens on the fact its three limits rest on, which is that there is no server and getCities fakes network latency over an array held in memory.
funkadelic
force-pushed
the
docs/readme-correctness-and-toc
branch
from
August 28, 2026 06:27
235fceb to
f76a21c
Compare
React, TypeScript, Vite and Vitest carry their major now. The major rather than the exact pin, since the manifest pins exactly and a patch bump would falsify the prose. The rest of the list stays bare. src/toolchain.test.ts compares the set of versioned entries before the values, so a deleted version fails there too.
funkadelic
force-pushed
the
docs/readme-correctness-and-toc
branch
from
August 28, 2026 06:37
e922a74 to
41a3756
Compare
Paragraphs and list items are one line each now, wrapped by the reader's editor rather than by hand. Code blocks, tables and the heading structure are untouched.
|
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.
The README got a few things wrong about the app, and Getting started left out the one thing that stops an install cold. Anyone on a Node version below 24 hit an error the README did nothing to explain. There is a table of contents at the top too, since the file is long enough to need one.