review: Goal 5 keeps content the document holds, the notes bullet names when each fires
CI / gate (push) Successful in 44s
CI / publish (push) Has been cancelled

This commit is contained in:
2026-09-30 22:29:38 +02:00
parent 1df58cf33e
commit 32df104649
2 changed files with 8 additions and 8 deletions
+7 -6
View File
@@ -39,10 +39,10 @@ In priority order.
4. **Output a person can edit.** A node CommonMark can spell gets that spelling; the lossless
flavour's directive form carries only what CommonMark cannot hold.
5. **Lossy conversion keeps the content.** `adfToPlainMarkdown` and `plainMarkdownToAdf` drop what
plain markdown cannot hold — format, design, structure — never content: what a reader of the
rendered document sees or follows, its text, images and link targets. The lossy pair creates and
exports; it never saves back over the document it read — a document's identity (task, mention,
media ids) survives a round trip only through the lossless pair.
plain markdown cannot hold — format, design, structure — never content the document holds: what
a reader of the rendered document sees or follows, its text, images and link targets. The lossy
pair creates and exports; it never saves back over the document it read — a document's identity
(task, mention, media ids) survives a round trip only through the lossless pair.
6. **What happens is what the audience expects.** Where the goals leave a choice, a conversion
takes the one its audience would predict, reading the input as written.
7. **Failures are values.** Nothing throws, and `code` is a closed list — as much a contract as
@@ -144,8 +144,9 @@ read replaces mentions, attachments and macros with text.
| `placeholder` | nothing | — |
- Content the document only references leaves an italic note naming it where it stood:
`_(image not included)_`, `_(jira-issues-table not included)_`, `_(synced block not included)_`,
`_(link card not included)_`, `_(extension not included)_`.
`_(image not included)_`, `_(synced block not included)_`, `_(link card not included)_` for a card
with no URL, and an extension's key, `_(jira-issues-table not included)_`, or
`_(extension not included)_` where it has none.
- `backgroundColor`, `code`, `em`, `link`, `strike` and `strong` stay; every other mark drops,
keeping its text, and so does a mark the flavour cannot spell where it stands.
- A newline in text is a hard break and in an expand's title a space, edge whitespace outside a
+1 -2
View File
@@ -158,8 +158,7 @@ renderer confirming each shape. Reader panels settled `error` as an error panel,
delimiter, so `は==日本語==で` (3 of 3), `==한국어==에서만` and `iPhone==専用==` (6 of 7) highlight,
the external image's two forms (6 of 7), the omission notes and a rule opening a list item
dropping (3 of 3), and a list's numbering overflowing into bullets (3 of 3, 5 of 7).
Content the document only references is marked where it stood, by a note that reads as the
converter's and names what was left out.
An omission note reads as the converter's, never as the author's.
Reading takes other tools' spellings, since it reads their output and writes none of them.
Rejected: `~sub~` and `^sup^` (`~2~` is a strike on GitHub, so `subsup` drops), underline and colour
spellings, raw HTML (`<details>`, `<mark>`), MkDocs `!!!` and the `:::` admonition family,