diff --git a/corpus/README.md b/corpus/README.md index e95ad87..097d0af 100644 --- a/corpus/README.md +++ b/corpus/README.md @@ -1,6 +1,6 @@ # The corpus -One directory per contract kind, each landing with its milestone: +One directory per contract kind: - `round-trip/` — `.json` + `.md`: the markdown `adfToMarkdown` must emit for that document, byte for byte, and that `markdownToAdf` must read back to it (`docs/decisions.md` §The @@ -16,8 +16,7 @@ One directory per contract kind, each landing with its milestone: is the suite; `refusals.json` pins each refusing example to its error `code`; `exceptions.json` pins each known divergence by `check`, `example`, `kind` and the exact `divergence`, with a `reason`. `kind` is `mark-model` (the permanent count divergence from ADF's mark-per-text-node - model), `unspellable` (parses but the flavour has no spelling) or `pending` (a parser gap a later - milestone may close). + model), `unspellable` (parses but the flavour has no spelling) or `pending` (a parser gap). JSON is editor-normal (`docs/decisions.md` §Equality is editor-normal), two-space indent, keys sorted. `spec.json` is the vendored, upstream machine-readable suite, byte-exact from