Skip to content

Commit 9547a27

Browse files
stevenjstevenj
committed
fix(docs): markdown and spelling issues
1 parent f968d2a commit 9547a27

23 files changed

+303
-276
lines changed

‎docs/src/architecture/08_concepts/rbac_id_uri/catalyst-id-uri.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ The overall `path` specification is: `<initial role0 key>/<role>/<rotation>#encr
149149
disambiguates Encryption Public Keys from signing public keys.
150150
* Roles can have 1 active public signing key, and 1 active public encryption key.
151151
* By default, the URL is referencing the signing public key.
152-
* If a public encryption key is being identified, then the fragment `#encrypt` is appended to the [Universal Resource Identifier].
152+
* If a public encryption key is being identified, then the fragment `#encrypt`
153+
is appended to the [Universal Resource Identifier].
153154

154155
## Reference Implementation
155156

‎docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md‎

Lines changed: 54 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ Only eligible users can cast ballots in the respective contest.
4141
* The voter signs this document to confirm their ballot.
4242
* Ballots can not be cast outside the time allowed for the casting of ballots.
4343
* The `document_id` and `document+ver` must be within the time of allowed casting
44-
of ballots. Any document_id of document_ver outside this time are invalid and will
44+
of ballots.
45+
Any document_id of document_ver outside this time are invalid and will
4546
not be counted.
4647

4748
#### Back End
@@ -143,7 +144,6 @@ Such documents may never be submitted.
143144
| Required | yes |
144145
| Format | [Document Reference](../metadata.md#document-reference) |
145146
| Valid References | [Contest Parameters](contest_parameters.md) |
146-
| Linked Reference Metadata | [`ref`](#ref) |
147147
<!-- markdownlint-enable MD033 -->
148148
A reference to the Parameters Document this document lies under.
149149

@@ -164,10 +164,6 @@ The profile template, or proposal templates could be defined at any of these
164164
levels, and as long as they all refer to the same chain of parameters in the
165165
hierarchy they are all valid.
166166

167-
* The Document referenced by [`ref`](../metadata.md#ref)
168-
* MUST contain [`parameters`](../metadata.md#parameters) metadata; AND
169-
* MUST match the referencing documents [`parameters`](../metadata.md#parameters) value.
170-
171167
## Payload
172168

173169
The Payload is a [CBOR][RFC8949] document that must conform to the `contest-ballot-payload` [CDDL][RFC8610].
@@ -207,267 +203,267 @@ Notes
207203
* All [CBOR][RFC8949] must use core-deterministic encoding so that content addressing remains stable.
208204

209205
### Schema
210-
<!-- markdownlint-disable max-one-sentence-per-line -->
206+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
211207
??? note "Payload [CDDL][RFC8610] Schema"
212208

213209
* [contest_ballot_payload.cddl](../cddl/contest_ballot_payload.cddl)
214210

215211
``` cddl
216212
{{ include_file('./../cddl/contest_ballot_payload.cddl', indent=4) }}
217213
```
218-
<!-- markdownlint-enable max-one-sentence-per-line -->
214+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
219215

220216
#### Sub-schemas
221217

222-
<!-- markdownlint-disable max-one-sentence-per-line -->
218+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
223219
??? note "Required Definition: document_ref"
224220

225221
* [document_ref.cddl](../cddl/document_ref.cddl)
226222

227223
``` cddl
228224
{{ include_file('./../cddl/document_ref.cddl', indent=4) }}
229225
```
230-
<!-- markdownlint-enable max-one-sentence-per-line -->
226+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
231227

232-
<!-- markdownlint-disable max-one-sentence-per-line -->
228+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
233229
??? note "Required Definition: document_id"
234230

235231
* [document_id.cddl](../cddl/document_id.cddl)
236232

237233
``` cddl
238234
{{ include_file('./../cddl/document_id.cddl', indent=4) }}
239235
```
240-
<!-- markdownlint-enable max-one-sentence-per-line -->
236+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
241237

242-
<!-- markdownlint-disable max-one-sentence-per-line -->
238+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
243239
??? note "Required Definition: uuid_v7"
244240

245241
* [uuid_v7.cddl](../cddl/uuid_v7.cddl)
246242

247243
``` cddl
248244
{{ include_file('./../cddl/uuid_v7.cddl', indent=4) }}
249245
```
250-
<!-- markdownlint-enable max-one-sentence-per-line -->
246+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
251247

252-
<!-- markdownlint-disable max-one-sentence-per-line -->
248+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
253249
??? note "Required Definition: document_ver"
254250

255251
* [document_ver.cddl](../cddl/document_ver.cddl)
256252

257253
``` cddl
258254
{{ include_file('./../cddl/document_ver.cddl', indent=4) }}
259255
```
260-
<!-- markdownlint-enable max-one-sentence-per-line -->
256+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
261257

262-
<!-- markdownlint-disable max-one-sentence-per-line -->
258+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
263259
??? note "Required Definition: document_locator"
264260

265261
* [document_locator.cddl](../cddl/document_locator.cddl)
266262

267263
``` cddl
268264
{{ include_file('./../cddl/document_locator.cddl', indent=4) }}
269265
```
270-
<!-- markdownlint-enable max-one-sentence-per-line -->
266+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
271267

272-
<!-- markdownlint-disable max-one-sentence-per-line -->
268+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
273269
??? note "Required Definition: cid"
274270

275271
* [cid.cddl](../cddl/cid.cddl)
276272

277273
``` cddl
278274
{{ include_file('./../cddl/cid.cddl', indent=4) }}
279275
```
280-
<!-- markdownlint-enable max-one-sentence-per-line -->
276+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
281277

282-
<!-- markdownlint-disable max-one-sentence-per-line -->
278+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
283279
??? note "Required Definition: cbor-cid"
284280

285281
* [cbor_cid.cddl](../cddl/cbor_cid.cddl)
286282

287283
``` cddl
288284
{{ include_file('./../cddl/cbor_cid.cddl', indent=4) }}
289285
```
290-
<!-- markdownlint-enable max-one-sentence-per-line -->
286+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
291287

292-
<!-- markdownlint-disable max-one-sentence-per-line -->
288+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
293289
??? note "Required Definition: choices"
294290

295291
* [choices.cddl](../cddl/choices.cddl)
296292

297293
``` cddl
298294
{{ include_file('./../cddl/choices.cddl', indent=4) }}
299295
```
300-
<!-- markdownlint-enable max-one-sentence-per-line -->
296+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
301297

302-
<!-- markdownlint-disable max-one-sentence-per-line -->
298+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
303299
??? note "Required Definition: clear-choices"
304300

305301
* [clear_choices.cddl](../cddl/clear_choices.cddl)
306302

307303
``` cddl
308304
{{ include_file('./../cddl/clear_choices.cddl', indent=4) }}
309305
```
310-
<!-- markdownlint-enable max-one-sentence-per-line -->
306+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
311307

312-
<!-- markdownlint-disable max-one-sentence-per-line -->
308+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
313309
??? note "Required Definition: clear-choice"
314310

315311
* [clear_choice.cddl](../cddl/clear_choice.cddl)
316312

317313
``` cddl
318314
{{ include_file('./../cddl/clear_choice.cddl', indent=4) }}
319315
```
320-
<!-- markdownlint-enable max-one-sentence-per-line -->
316+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
321317

322-
<!-- markdownlint-disable max-one-sentence-per-line -->
318+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
323319
??? note "Required Definition: elgamal-ristretto255-encrypted-choices"
324320

325321
* [elgamal_ristretto255_encrypted_choices.cddl](../cddl/elgamal_ristretto255_encrypted_choices.cddl)
326322

327323
``` cddl
328324
{{ include_file('./../cddl/elgamal_ristretto255_encrypted_choices.cddl', indent=4) }}
329325
```
330-
<!-- markdownlint-enable max-one-sentence-per-line -->
326+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
331327

332-
<!-- markdownlint-disable max-one-sentence-per-line -->
328+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
333329
??? note "Required Definition: elgamal-ristretto255-encrypted-choice"
334330

335331
* [elgamal_ristretto255_encrypted_choice.cddl](../cddl/elgamal_ristretto255_encrypted_choice.cddl)
336332

337333
``` cddl
338334
{{ include_file('./../cddl/elgamal_ristretto255_encrypted_choice.cddl', indent=4) }}
339335
```
340-
<!-- markdownlint-enable max-one-sentence-per-line -->
336+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
341337

342-
<!-- markdownlint-disable max-one-sentence-per-line -->
338+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
343339
??? note "Required Definition: elgamal-ristretto255-group-element"
344340

345341
* [elgamal_ristretto255_group_element.cddl](../cddl/elgamal_ristretto255_group_element.cddl)
346342

347343
``` cddl
348344
{{ include_file('./../cddl/elgamal_ristretto255_group_element.cddl', indent=4) }}
349345
```
350-
<!-- markdownlint-enable max-one-sentence-per-line -->
346+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
351347

352-
<!-- markdownlint-disable max-one-sentence-per-line -->
348+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
353349
??? note "Required Definition: row-proof"
354350

355351
* [row_proof.cddl](../cddl/row_proof.cddl)
356352

357353
``` cddl
358354
{{ include_file('./../cddl/row_proof.cddl', indent=4) }}
359355
```
360-
<!-- markdownlint-enable max-one-sentence-per-line -->
356+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
361357

362-
<!-- markdownlint-disable max-one-sentence-per-line -->
358+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
363359
??? note "Required Definition: zkproof-elgamal-ristretto255-unit-vector-with-single-selection"
364360

365361
* [zkproof_elgamal_ristretto255_unit_vector_with_single_selection.cddl](../cddl/zkproof_elgamal_ristretto255_unit_vector_with_single_selection.cddl)
366362

367363
``` cddl
368364
{{ include_file('./../cddl/zkproof_elgamal_ristretto255_unit_vector_with_single_selection.cddl', indent=4) }}
369365
```
370-
<!-- markdownlint-enable max-one-sentence-per-line -->
366+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
371367

372-
<!-- markdownlint-disable max-one-sentence-per-line -->
368+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
373369
??? note "Required Definition: zkproof-elgamal-ristretto255-unit-vector-with-single-selection-item"
374370

375371
* [zkproof_elgamal_ristretto255_unit_vector_with_single_selection_item.cddl](../cddl/zkproof_elgamal_ristretto255_unit_vector_with_single_selection_item.cddl)
376372

377373
``` cddl
378374
{{ include_file('./../cddl/zkproof_elgamal_ristretto255_unit_vector_with_single_selection_item.cddl', indent=4) }}
379375
```
380-
<!-- markdownlint-enable max-one-sentence-per-line -->
376+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
381377

382-
<!-- markdownlint-disable max-one-sentence-per-line -->
378+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
383379
??? note "Required Definition: zkproof-elgamal-announcement"
384380

385381
* [zkproof_elgamal_announcement.cddl](../cddl/zkproof_elgamal_announcement.cddl)
386382

387383
``` cddl
388384
{{ include_file('./../cddl/zkproof_elgamal_announcement.cddl', indent=4) }}
389385
```
390-
<!-- markdownlint-enable max-one-sentence-per-line -->
386+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
391387

392-
<!-- markdownlint-disable max-one-sentence-per-line -->
388+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
393389
??? note "Required Definition: zkproof-elgamal-group-element"
394390

395391
* [zkproof_elgamal_group_element.cddl](../cddl/zkproof_elgamal_group_element.cddl)
396392

397393
``` cddl
398394
{{ include_file('./../cddl/zkproof_elgamal_group_element.cddl', indent=4) }}
399395
```
400-
<!-- markdownlint-enable max-one-sentence-per-line -->
396+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
401397

402-
<!-- markdownlint-disable max-one-sentence-per-line -->
398+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
403399
??? note "Required Definition: zkproof-ed25519-r-response"
404400

405401
* [zkproof_ed25519_r_response.cddl](../cddl/zkproof_ed25519_r_response.cddl)
406402

407403
``` cddl
408404
{{ include_file('./../cddl/zkproof_ed25519_r_response.cddl', indent=4) }}
409405
```
410-
<!-- markdownlint-enable max-one-sentence-per-line -->
406+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
411407

412-
<!-- markdownlint-disable max-one-sentence-per-line -->
408+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
413409
??? note "Required Definition: zkproof-ed25519-scalar"
414410

415411
* [zkproof_ed25519_scalar.cddl](../cddl/zkproof_ed25519_scalar.cddl)
416412

417413
``` cddl
418414
{{ include_file('./../cddl/zkproof_ed25519_scalar.cddl', indent=4) }}
419415
```
420-
<!-- markdownlint-enable max-one-sentence-per-line -->
416+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
421417

422-
<!-- markdownlint-disable max-one-sentence-per-line -->
418+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
423419
??? note "Required Definition: column-proof"
424420

425421
* [column_proof.cddl](../cddl/column_proof.cddl)
426422

427423
``` cddl
428424
{{ include_file('./../cddl/column_proof.cddl', indent=4) }}
429425
```
430-
<!-- markdownlint-enable max-one-sentence-per-line -->
426+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
431427

432-
<!-- markdownlint-disable max-one-sentence-per-line -->
428+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
433429
??? note "Required Definition: matrix-proof"
434430

435431
* [matrix_proof.cddl](../cddl/matrix_proof.cddl)
436432

437433
``` cddl
438434
{{ include_file('./../cddl/matrix_proof.cddl', indent=4) }}
439435
```
440-
<!-- markdownlint-enable max-one-sentence-per-line -->
436+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
441437

442-
<!-- markdownlint-disable max-one-sentence-per-line -->
438+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
443439
??? note "Required Definition: voter-choice"
444440

445441
* [voter_choice.cddl](../cddl/voter_choice.cddl)
446442

447443
``` cddl
448444
{{ include_file('./../cddl/voter_choice.cddl', indent=4) }}
449445
```
450-
<!-- markdownlint-enable max-one-sentence-per-line -->
446+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
451447

452-
<!-- markdownlint-disable max-one-sentence-per-line -->
448+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
453449
??? note "Required Definition: aes-ctr-encrypted-choices"
454450

455451
* [aes_ctr_encrypted_choices.cddl](../cddl/aes_ctr_encrypted_choices.cddl)
456452

457453
``` cddl
458454
{{ include_file('./../cddl/aes_ctr_encrypted_choices.cddl', indent=4) }}
459455
```
460-
<!-- markdownlint-enable max-one-sentence-per-line -->
456+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
461457

462-
<!-- markdownlint-disable max-one-sentence-per-line -->
458+
<!-- markdownlint-disable max-one-sentence-per-line MD046 MD013 -->
463459
??? note "Required Definition: aes-ctr-encrypted-block"
464460

465461
* [aes_ctr_encrypted_block.cddl](../cddl/aes_ctr_encrypted_block.cddl)
466462

467463
``` cddl
468464
{{ include_file('./../cddl/aes_ctr_encrypted_block.cddl', indent=4) }}
469465
```
470-
<!-- markdownlint-enable max-one-sentence-per-line -->
466+
<!-- markdownlint-enable max-one-sentence-per-line MD046 MD013 -->
471467

472468
## Signers
473469

0 commit comments

Comments
 (0)