3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-20 15:15:44 +01:00

Retitle the mark-skipping decision to name the link and directive marks it refuses, and land item 73 last in 0.3.0

This commit is contained in:
2026-10-14 22:05:26 +02:00
committed by Lillem4n
parent 7cac2b4a9c
commit 492a7fa828
3 changed files with 12 additions and 20 deletions
+1 -1
View File
@@ -28,7 +28,7 @@ In `docs/decisions.md`:
- Tables - Tables
- Links - Links
- An image reads as an image only alone in its paragraph, else as its alt text linked; a link text of hard breaks alone reads as its destination, then the breaks - An image reads as an image only alone in its paragraph, else as its alt text linked; a link text of hard breaks alone reads as its destination, then the breaks
- A mark skips a node that cannot hold it, and a mark wrapping only such nodes is refused, but for a link around hard breaks alone - A mark skips a node that cannot hold it, and a link or directive mark wrapping only such nodes is refused, but for a link around hard breaks alone
- A linked image is written `[![alt](url)](href)`, a captioned image as its directive - A linked image is written `[![alt](url)](href)`, a captioned image as its directive
- Ids stay site-local - Ids stay site-local
- Portable task ids come from position - Portable task ids come from position
+5 -4
View File
@@ -256,16 +256,17 @@ The same panel confirmed the other readings on 2026-10-09: a title as the captio
text as linked alt text, and an empty link text as its URL, each 3 of 3; `[]()` as nothing, 5 of 7. text as linked alt text, and an empty link text as its URL, each 3 of 3; `[]()` as nothing, 5 of 7.
Their CommonMark suite exceptions are `node-model` (§The CommonMark suite checks three ways). Their CommonMark suite exceptions are `node-model` (§The CommonMark suite checks three ways).
## A mark skips a node that cannot hold it, and a mark wrapping only such nodes is refused, but for a link around hard breaks alone ## A mark skips a node that cannot hold it, and a link or directive mark wrapping only such nodes is refused, but for a link around hard breaks alone
2026-10-14, two reader panels of the viewer/editor app, the LLM pipeline and a support agent, 3 of 2026-10-14, two reader panels of the viewer/editor app, the LLM pipeline and a support agent, 3 of
3 each. Goals 1, 4 and 6. Valid while Atlassian's schema withholds marks from inline nodes. Extended 3 each. Goals 1, 4 and 6. Valid while Atlassian's schema withholds marks from inline nodes. Extended
to code text under this rule, without a panel, 2026-10-14. to code text under this rule, without a panel, 2026-10-14; retitled by the maintainer the same day.
A mark spelling skips a node that takes none of its type, code text included, which takes only A mark spelling skips a node that takes none of its type, code text included, which takes only
`code`, `link` and `annotation`. So `**Ping !adf:mention[@A]{id=x} now**` reads as bold text around a plain `code`, `link` and `annotation`. So `**Ping !adf:mention[@A]{id=x} now**` reads as bold text around a plain
mention, and ``**`npm ci`**`` as plain code. A link whose text holds something besides hard breaks, mention, and ``**`npm ci`**`` as plain code. A directive mark wrapping only such nodes, and a link
but no node that takes a link, is `unsupported-node-shape` in `losslessMarkdownToAdf`: the panel whose text holds something besides hard breaks but no node that takes a link, is
`unsupported-node-shape` in `losslessMarkdownToAdf`: the panel
refused to have `[!adf:status[Done]{color=green}](/u)` read as `/u` linked beside the status. A link refused to have `[!adf:status[Done]{color=green}](/u)` read as `/u` linked beside the status. A link
text of hard breaks alone still reads as its destination, then the breaks (§An image reads as an text of hard breaks alone still reads as its destination, then the breaks (§An image reads as an
image only alone in its paragraph). `adfToLosslessMarkdown` writes a node holding a mark its type image only alone in its paragraph). `adfToLosslessMarkdown` writes a node holding a mark its type
+6 -15
View File
@@ -39,7 +39,6 @@
| 33 | 0.3.0 | defect | **Emit a line in time linear in its mark runs, in `adfToLosslessMarkdown` and `adfToPortableMarkdown`.** | 4 | 5 | 8 | 6 | 9 | 9 | 8.7 | | 33 | 0.3.0 | defect | **Emit a line in time linear in its mark runs, in `adfToLosslessMarkdown` and `adfToPortableMarkdown`.** | 4 | 5 | 8 | 6 | 9 | 9 | 8.7 |
| 98 | 0.3.0 | defect | **Read blank lines inside deeply nested list items in time linear in the markdown.** | 3 | 3 | 7 | 5 | 9 | 9 | 8.2 | | 98 | 0.3.0 | defect | **Read blank lines inside deeply nested list items in time linear in the markdown.** | 3 | 3 | 7 | 5 | 9 | 9 | 8.2 |
| 102 | 0.3.0 | decision | **Place a block a portable task list refuses at its path in the returned document without replaying `splitTaskList` on stand-in nodes.** | 3 | 4 | 7 | 2 | 4 | 1 | 8.0 | | 102 | 0.3.0 | decision | **Place a block a portable task list refuses at its path in the returned document without replaying `splitTaskList` on stand-in nodes.** | 3 | 4 | 7 | 2 | 4 | 1 | 8.0 |
| 116 | 0.3.0 | question | **Retitle `docs/decisions.md` §A mark skips a node that cannot hold it to say only a link or directive mark wrapping only such nodes is refused.** | 1 | 1 | 1 | 2 | 3 | 6 | 5.4 |
| 109 | 0.3.0 | defect | **Spell nested lists and quotes in time linear in the markdown.** | 3 | 5 | 8 | 4 | 7 | 9 | 5.3 | | 109 | 0.3.0 | defect | **Spell nested lists and quotes in time linear in the markdown.** | 3 | 5 | 8 | 4 | 7 | 9 | 5.3 |
| 7 | 0.4.0 | decision | **Ship HTML: `adfToHtml`, `htmlToAdf`, and markdown to and from HTML composed through ADF, each call named by its flavour.** | 6 | 9 | 9 | 9 | 9 | 2, 4 | 25.8 | | 7 | 0.4.0 | decision | **Ship HTML: `adfToHtml`, `htmlToAdf`, and markdown to and from HTML composed through ADF, each call named by its flavour.** | 6 | 9 | 9 | 9 | 9 | 2, 4 | 25.8 |
| 45 | 0.4.0 | | **Replace `isAdfDocument` with a reader returning `Result<AdfDocument>`.** | 2 | 3 | 4 | 6 | 8 | 1 | 25.2 | | 45 | 0.4.0 | | **Replace `isAdfDocument` with a reader returning `Result<AdfDocument>`.** | 2 | 3 | 4 | 6 | 8 | 1 | 25.2 |
@@ -71,12 +70,12 @@
### 73. Announce the package where someone needing an ADF converter already reads: JRACLOUD-77436, the Atlassian developer community and Stack Overflow's ADF-to-markdown questions. ### 73. Announce the package where someone needing an ADF converter already reads: JRACLOUD-77436, the Atlassian developer community and Stack Overflow's ADF-to-markdown questions.
Each post links the GitHub repository, the README's comparison table and a README that opens with Lands after every other `0.3.0` item (the maintainer, 2026-10-14). Each post links the GitHub
what the package is. Before posting, set `converter-comparison/run.sh`'s pins to each package's repository, the README's comparison table and a README that opens with what the package is. Before
latest version, `@larvit/adf-codec@0.3.0` included, and `--before` to today. Run it, then bring the posting, set `converter-comparison/run.sh`'s pins to each package's latest version,
README table, its versions and its date in step with the output. We draft each post for the place it `@larvit/adf-codec@0.3.0` included, and `--before` to today. Run it, then bring the README table,
goes; the maintainer posts them once `0.3.0` is published. Found while planning discoverability, its versions and its date in step with the output. We draft each post for the place it goes; the
2026-10-04. maintainer posts them once `0.3.0` is published. Found while planning discoverability, 2026-10-04.
### 99. Write a linked external image standing inline or in a table cell in the spelling a reader panel picks, in `adfToPortableMarkdown`. ### 99. Write a linked external image standing inline or in a table cell in the spelling a reader panel picks, in `adfToPortableMarkdown`.
@@ -184,14 +183,6 @@ the fix.
`taskOfParagraphs` keeps the original child objects. Both paired-ruling seats on 2026-10-11 named it `taskOfParagraphs` keeps the original child objects. Both paired-ruling seats on 2026-10-11 named it
the reason the project read worse. the reason the project read worse.
### 116. Retitle `docs/decisions.md` §A mark skips a node that cannot hold it to say only a link or directive mark wrapping only such nodes is refused.
The title says "a mark wrapping only such nodes is refused", but emphasis wrapping only a mention or
a code span reads as the plain node, as the entry's body says. Proposed title: "A mark skips a node
that cannot hold it, and a link or directive mark wrapping only such nodes is refused, but for a link
around hard breaks alone", with `AGENTS.md`'s index line. Found by the prose review of item 114,
2026-10-14.
### 109. Spell nested lists and quotes in time linear in the markdown. ### 109. Spell nested lists and quotes in time linear in the markdown.
Each level of a nested list or quote re-indents its whole text, so the work is the depth times the Each level of a nested list or quote re-indents its whole text, so the work is the depth times the