3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-12 11:48:29 +01:00

Answer prose round 1: 0 🔴, 3 🟡 (0 misread); title the decision for ADF converters and shorten the report's section

This commit is contained in:
2026-11-09 10:48:22 +01:00
committed by Lillem4n
parent 93d506ddb7
commit 1a875387ca
3 changed files with 8 additions and 10 deletions
+1 -1
View File
@@ -87,7 +87,7 @@ In `docs/decisions.md`:
- Readable spellings take the `try` prefix
- The attribute vocabulary is ADF's
- The source parts by ADF and format
- The comparison table lists every converter that starts and converts
- The comparison tables list every ADF converter that starts and converts
- The real-world corpus holds anonymized documents from sites whose licence it records
- The feature table is a section per corpus example, led by a summary table
+4 -4
View File
@@ -1195,17 +1195,17 @@ format's ban on the other format, and `ci.sh` probes every override. They are li
test that scans the source, and a lint rule reads every import spelling: `from`, a bare `import`,
double quotes and a dynamic `import()`.
## The comparison table lists every converter that starts and converts
## The comparison tables list every ADF converter that starts and converts
2026-10-28, the maintainer, answering the bar for the README's "Other ADF converters" table. It
serves goal 3: a developer choosing a converter sees every one, and what it gets wrong.
A converter that starts and converts anything stays in its table, however poorly. Its row says where
A converter that starts and converts any ADF stays in its table, however poorly. Its row says where
it fails ordinary input, such as a list or a quote. A converter that doesn't start, or needs a page
rather than Node, goes in the second table. A wrapper or fork of a listed package is left out.
A converter that never reads or writes ADF is left out of both. 2026-11-09, the maintainer: a Go
program that writes Confluence storage format (`docs/kovetskiy-mark.md`) gets no row.
A converter that never reads or writes ADF is left out of both. 2026-11-09, the maintainer:
`kovetskiy/mark`, which writes Confluence storage format (`docs/kovetskiy-mark.md`), gets no row.
## The real-world corpus holds anonymized documents from sites whose licence it records
+3 -5
View File
@@ -75,12 +75,10 @@ A user of `mark` who needs ADF can fetch the page as ADF through the Confluence
converts storage format to ADF. A user of this package who needs storage format goes to that same
API (`README.md` §Other ADF converters).
## Does it belong in the comparison table
## Does it belong in the comparison tables
Neither table fits. The first lists npm packages that run in Node and convert ADF to or from
markdown. The second lists converters the comparison does not run, and every library in it converts
ADF. `mark` is a Go program that never touches ADF, so it is left out of both
(`docs/decisions.md` §The comparison table lists every converter that starts and converts).
`mark` never reads or writes ADF, so it is left out of both
(`docs/decisions.md` §The comparison tables list every ADF converter that starts and converts).
No spelling changes follow: `[!IMPORTANT]` is the README's choice to reopen, not a defect, and only
a writer panel changes a spelling (`AGENTS.md` §7).