aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2018-01-04 16:33:50 +0000
committerng0 <ng0@n0.is>2018-01-04 16:33:50 +0000
commite9c8850dd6324241c4e1567289b617be44bda1d3 (patch)
tree5e4421f4cdd553fd6b8220fef77eb3ce3b3c67d8 /doc/documentation
parent2560f7683d7184dc6cdcc3324014663d047c3447 (diff)
downloadgnunet-e9c8850dd6324241c4e1567289b617be44bda1d3.tar.gz
gnunet-e9c8850dd6324241c4e1567289b617be44bda1d3.zip
doc/documentation/README.txt: remove obsolete lines
Diffstat (limited to 'doc/documentation')
-rw-r--r--doc/documentation/README.txt41
1 files changed, 0 insertions, 41 deletions
diff --git a/doc/documentation/README.txt b/doc/documentation/README.txt
index e3eb6c8ac..9e76394c3 100644
--- a/doc/documentation/README.txt
+++ b/doc/documentation/README.txt
@@ -1,44 +1,3 @@
1To be moved to an appropriate section of "how to write documentation" or
2"how to contribute to the documentation":
3
41. When writing documentation, please use gender-neutral wording when
5 referring to people, such as singular “they”, “their”, “them”, and
6 so forth. -> https://en.wikipedia.org/wiki/Singular_they
7
82. Keep line length below 74 characters.
9 - Expection by texi2pdf output so far: URLs will break
10 (inserted whitespace) when they contain linebreaks
11 within the @url{} / @uref{}.
12
133. Do not use tab characters (see chapter 2.1 texinfo manual)
14
154. Use neutral language and third person perspective in the text
16
174.1 So, when you refer to a user in general or addressing the user,
18 refer to (1).
194.1.1 Unsolved exceptions for canonical reasons:
20 When refering to Alice, use "she".
21 When refering to Bob, use "he".
22 These are long established examples and they
23 should either be replaced (avoid Alice and Bob
24 examples when you can) or followed.
25
265. Use 2 spaces between sentences, so instead of:
27
28 We do this and the other thing. This is done by foo.
29
30 Write:
31
32 We do this and the other thing. This is done by foo.
33
346. Use @footnote{} instead of putting an @*ref{} to the footnote on a
35 collected footnote-page.
36 In a 200+ pages handbook it's better to have footnotes accessible
37 without having to skip over to the end.
38
396.1 Avoid unnecessary footnotes, keep the text self-explanatory and
40 in a simple language where possible/necessary.
41
42* Completion Levels: 1* Completion Levels:
43 2
44** chapters/philosophy: around 100% fixed after initial export. 3** chapters/philosophy: around 100% fixed after initial export.