docs: renumber the README layer table so it matches the "3 layers" claim - #205
Open
rajarshidattapy wants to merge 1 commit into
Open
docs: renumber the README layer table so it matches the "3 layers" claim#205rajarshidattapy wants to merge 1 commit into
rajarshidattapy wants to merge 1 commit into
Conversation
Contributor
🟢 No documentation gap found — medium confidenceThe automated review found no documentation gap in the supplied changes. This review is advisory and does not block merging. |
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
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.
Description
README.md:31says:The table directly beneath it numbered four rows,
1.through4., starting with Live browser control — the thing the sentence says the layers sit on top of. So the README claimed three layers and then showed four.This renumbers the table
0.–3., which makes the prose literally true: layer 0 is live browser control, and layers 1–3 are the three learnings built on it. No prose changes were needed.Closes #204
Note on the "collapses cost" sentence
The same paragraph ends with "Each layer collapses cost and variance for the layer above it." I checked whether that direction was also wrong and it is correct — reading down the table, each row makes the row above it cheaper: a sitemap makes live browsing cheaper, an authored adapter makes sitemap-guided work cheaper, and a tailored command makes adapter authoring cheaper. Left untouched.
Type of Change
Checklist
Notes on the checklist:
README.md. No code, tests, or generated artifacts are touched.## Demo; the generated community-plugins table between thewebcmd-community-pluginsmarkers is untouched, sonpm run check-community-pluginsis unaffected.Adapter Notes
Not applicable — no adapter is added or modified in this PR.
CliErrorsubclasses instead of rawErrorScreenshots / Output
One file, +4 / -4:
Rendered, the table now reads as one base layer plus the three learnings the sentence promises.