You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(get-started): rewrite the introduction in Simplified Technical English (#120) #122
Deferred from #120, which is closed. #121 fixed the eight other acceptance criteria of that
review and landed on staging as 56cab1b. This one remains, and it is not a false published
claim, so it does not block the v0.1.0 tag.
src/content/docs/get-started/index.md:10-20 uses long sentences, fragments, metaphors ("the
citation becomes the doorway"), and ambiguous claims such as "No central host."
The page is the front door of the site. A reader who does not read English as a first language
meets it first, and a translator meets it next. The prose is written for effect rather than for
transfer.
The unconditional persistence claim in the same paragraph is already fixed in 56cab1b: the
sentence now reads "permanent once the record is active". Only the style question is open.
TextRefs assigns a URI to a passage. It does not host text or replace editions. It links the
passage to editions, identifiers, and resolver URLs. Only active records have a persistence
guarantee.
Define the four record types in a table or a short list.
Keep every fact the current page states. This is a rewrite for style, not a cut of scope.
Apply the same pass to the de translation of the page, so the pair does not drift.
Acceptance criteria
The get-started introduction uses short, literal, status-accurate sentences.
Each instruction sentence is under 20 words, and each descriptive sentence is under 25.
The four record types appear as a table or a short list.
Context
Deferred from #120, which is closed. #121 fixed the eight other acceptance criteria of that
review and landed on
stagingas56cab1b. This one remains, and it is not a false publishedclaim, so it does not block the v0.1.0 tag.
The finding, as #120 stated it
src/content/docs/get-started/index.md:10-20uses long sentences, fragments, metaphors ("thecitation becomes the doorway"), and ambiguous claims such as "No central host."
The page is the front door of the site. A reader who does not read English as a first language
meets it first, and a translator meets it next. The prose is written for effect rather than for
transfer.
The unconditional persistence claim in the same paragraph is already fixed in
56cab1b: thesentence now reads "permanent once the record is
active". Only the style question is open.What to do
Replace the opening with short, literal statements. review: address PR #4 clarity and minimalism findings before v0.1.0 #120 proposed this shape:
Define the four record types in a table or a short list.
Keep every fact the current page states. This is a rewrite for style, not a cut of scope.
Apply the same pass to the
detranslation of the page, so the pair does not drift.Acceptance criteria
npm run verifypasses.Related: #4, #120, #121.