docs: correct four documents against what the code and git say - #191
Merged
Conversation
- the readme told a blogger every release resets their settings; git says `index.xml` has not changed since 1.0.0 and the changelog says so too, so the readme was the one contradicting both - three documents counted four development dependencies, which stopped being true when fontverter was declared for the font rename - ADR-0003 names a file under the name it had before Hangul joined it, and records the family rename as verified when only the stylesheet had been renamed; amended rather than rewritten, since the rest is history - record in measuring.md why that verification looked like proof: `document.fonts` answers with the `@font-face` family, which is the name css gives a file rather than the name inside it
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.
A second sweep, resolving every path, custom property, npm script and counted
claim in the documents against the tree — and the numbers against the built
files.
What was wrong
The readme misled a blogger about upgrading. It said Tistory clears skin
settings whenever
index.xmlchanges, "which every release does". It does not:The changelog already said so at the top of 1.0.1 — "the first time that has
been true of any release here". The readme was contradicting it, and the readme
is what someone reads before deciding to upgrade.
Three documents counted four development dependencies. There are five;
fontverter was declared yesterday for the font rename. SECURITY.md,
THIRD-PARTY-NOTICES.md and ADR-0001 all had the old count — drift introduced by
that fix and caught by this sweep.
ADR-0003 records a rename that had not happened. It names
images/quiet-latin.woff2, which becamequiet-sans-latin.woff2when Hanguljoined it, and its validation section reads:
That was measuring the
@font-facedeclaration, not the font. Amended ratherthan rewritten — the rest of the ADR is an accurate record of the decision.
docs/tistory-spec.mdcarried the same "every release" assumption in an openquestion.
Added
docs/measuring.mdgains the trap that let the font defect live for threereleases:
document.fontsreports the family CSS asked for, so a page can sayQuiet Sans / loadedwhile the file it loaded calls itself something else. Plustwo smaller ones found while verifying that fix — a width measured on a block
element measures the block, and synthesised bold need not be wider (it carried
1.57× the ink at the same width).
What the sweep found clean
No secrets in the tree or anywhere in its history. No network at build or run
time; the only URLs in the package are the SVG namespace and this project's own
links. Every documented size still matches the built files (53 KB Latin, 568 KB
Hangul, 621 KB together, 2.0 MB source). Neither shipped font carries the
reserved name in any identifying record. CI permissions still minimal.
Validation
node scripts/check.mjs— 26 checks, passed.