Heiko Schaefer
8f5d9f48a1
Add a note that diagram spelling should not be fixed.
...
We'll fix diagram spellings in the course of the merge into the future 'main' branch.
2023-11-02 19:51:32 +01:00
David Runge
32a05d2c5b
Remove bat based Make file for Windows as it is unused
...
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:10 +01:00
David Runge
4459b3b2a9
Add CI job to run codespell on all source files
...
Fixes https://codeberg.org/openpgp/notes/issues/96
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:09 +01:00
David Runge
82f59746f2
Add codespell integration, which checks all sources
...
Add a make target for running `codespell` on all sources.
Skip running codespell on the build directory (we have javascript etc.
in there).
Only emit warnings but do not fail on spelling errors in diagrams.
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:05 +01:00
David Runge
cb4ac38e05
Fix spelling in source files
...
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 18:41:36 +01:00
Tammi L. Coles
dde0eae900
spell out the "not unique" issue to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291244
2023-11-02 17:52:35 +01:00
Tammi L. Coles
6d9bf44ba5
change fingerprint language to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291232
2023-11-02 17:46:55 +01:00
Tammi L. Coles
4d695764d0
connect metadata paragraphs better to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291216
2023-11-02 17:42:27 +01:00
Tammi L. Coles
e878c637b8
edit 118 to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291275
2023-11-02 17:31:14 +01:00
David Runge
e13127e064
When link checking, always build HTML from scratch
...
To be on the safe side, always build HTML pages from scratch, so that
lychee checks the actual current version of the files.
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:18 +01:00
David Runge
c9e7b03f53
Fail on warnings when building with sphinx-build
...
Fixes https://codeberg.org/openpgp/notes/issues/90
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:18 +01:00
David Runge
5fd9676392
Add a file to keep the static dir around when cloning the repo
...
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:17 +01:00
David Runge
415fb44ace
Do not fail on footnotes directly following a heading
...
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:16 +01:00
David Runge
a88e3023a8
Move 06-terminology.md to a temporary location
...
As mermaid pulls in many dependencies and is not setup in CI,
sphinx-build will fail on trying to render the file.
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:15 +01:00
Heiko Schaefer
3e64c68f92
use direct link (link checks in codeberg CI are currently failing for the archive.org link)
2023-11-02 14:55:25 +01:00
Heiko Schaefer
2a5667062e
ch17: use public key and direct key signature packet diagrams
2023-11-02 13:54:39 +01:00
Tammi L. Coles
bb146b6d8d
Merge pull request 'tammi-ch17' ( #91 ) from tammi-ch17 into draft
...
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/91
Reviewed-by: Tammi L. Coles <tlcoles@noreply.codeberg.org>
2023-11-02 12:48:28 +00:00
Tammi L. Coles
333a8862ac
change to calculated
2023-11-02 13:47:20 +01:00
Tammi L. Coles
43faca00e3
correct for hash digest, move reference
2023-11-02 13:44:28 +01:00
Tammi L. Coles
00270a07e5
remove extra space
2023-11-02 13:07:45 +01:00
Tammi L. Coles
e20658c249
resolve https://codeberg.org/openpgp/notes/pulls/91#issuecomment-1310156
2023-11-02 12:46:02 +01:00
Tammi L. Coles
a6516a949c
resolve https://codeberg.org/openpgp/notes/pulls/91#issuecomment-1305908
2023-11-02 12:38:25 +01:00
Tammi L. Coles
d37382d43d
Merge branch 'draft' into tammi-ch17
2023-11-02 10:42:41 +00:00
Tammi L. Coles
33cab7b59a
change period to colon
2023-11-02 10:17:49 +01:00
Tammi L. Coles
1748c04cd2
Merge pull request 'ch17: clearly mark different sections of packet discussions' ( #93 ) from heiko-ch17 into tammi-ch17
...
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/93
2023-11-02 09:13:41 +00:00
Heiko Schaefer
ed7ab4760f
ch6: Use new diagram
2023-11-01 21:40:49 +01:00
Heiko Schaefer
5b0eb1948a
Import new diagrams
2023-11-01 21:34:51 +01:00
Heiko Schaefer
77c901889b
Terminology fix
2023-10-30 00:28:43 +01:00
Heiko Schaefer
1dbe95cb1f
fix link names
2023-10-29 23:47:36 +01:00
Heiko Schaefer
bedae03c42
fix todo admonition syntax
2023-10-29 23:36:35 +01:00
Heiko Schaefer
b257e9a366
moved "VISUAL" admonitions to #95
...
we should consider if we want such diagrams after the core writing phase (if we have time).
2023-10-29 23:14:32 +01:00
Heiko Schaefer
d44226d288
ch5: use new diagrams
2023-10-29 23:07:51 +01:00
Heiko Schaefer
4a568be351
import new diagrams
2023-10-29 23:07:50 +01:00
heiko
256276af2e
Merge pull request 'Chapter 6-8 [Paul +Heiko edits]' ( #88 ) from sigs-h into draft
...
These chapters are still in draft quality (and will be copy edited and reviewed later)
2023-10-29 21:50:40 +00:00
Heiko Schaefer
3f536dfaaa
ch7: merge in old text, edits
2023-10-29 22:44:07 +01:00
3ec73a8549
Initial work on Data Signatures chapter
2023-10-29 22:44:07 +01:00
Heiko Schaefer
4c52063536
ch6: add link anchor
2023-10-29 22:44:07 +01:00
Heiko Schaefer
e33ead3bb9
ch19: fix signature examples
...
- now the inline signature has a v6 One-Pass Signature packet
- don't generate differing signatures by running the non-deterministic `sq sign` multiple times
2023-10-29 22:44:07 +01:00
Heiko Schaefer
79f122114b
ch19: "zooming in" data signature examples
2023-10-29 22:44:07 +01:00
Heiko Schaefer
6c85ca62de
ch6: add short text about notations
2023-10-29 22:44:07 +01:00
Heiko Schaefer
a3b143d732
ch8: edits
2023-10-29 22:44:07 +01:00
Heiko Schaefer
fd0f0fe713
ch8: add clarifications
2023-10-29 22:44:07 +01:00
Heiko Schaefer
67ee9bfbe7
ch6, ch7: add notes
2023-10-29 22:44:07 +01:00
Heiko Schaefer
e7350e8f7a
ch6: rfc links
2023-10-29 22:44:07 +01:00
Heiko Schaefer
f9ab3ca17b
ch8: rfc links
2023-10-29 22:44:07 +01:00
Heiko Schaefer
e2d3fabdc5
ch8: more introductory text
2023-10-29 22:44:07 +01:00
Heiko Schaefer
33ad6fcd69
ch6: visual note
2023-10-29 22:44:07 +01:00
Heiko Schaefer
0cf0c2069c
swap chapters on signing components and data
2023-10-29 22:44:07 +01:00
Heiko Schaefer
06d3e1f230
edit moved/split out ch7
2023-10-29 22:44:07 +01:00
Heiko Schaefer
4000e1efdc
edit new ch6
2023-10-29 22:44:07 +01:00
