projects
/
oweals
/
gnunet.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
| inline |
side by side
(parent:
68705e6
)
doc README
author
ng0
<ng0@infotropique.org>
Fri, 3 Nov 2017 07:57:29 +0000
(07:57 +0000)
committer
ng0
<ng0@infotropique.org>
Fri, 3 Nov 2017 07:57:29 +0000
(07:57 +0000)
doc/documentation/README.txt
patch
|
blob
|
history
diff --git
a/doc/documentation/README.txt
b/doc/documentation/README.txt
index 6a34509a7d56a8de3ce29cb1f21714e8d6bcdd2d..c3dda87c522d42388aad9d57cca271e836b629d0 100644
(file)
--- a/
doc/documentation/README.txt
+++ b/
doc/documentation/README.txt
@@
-22,6
+22,13
@@
To be moved to an appropriate section of "how to write documentation" or
We do this and the other thing. This is done by foo.
+6. Use @footnote{} instead of putting an @*ref{} to the footnote on a
+ collected footnote-page.
+ In a 200+ pages handbook it's better to have footnotes accessible
+ without having to skip over to the end.
+
+6.1 Avoid unnecessary footnotes, keep the text self-explanatory and
+ in a simple language where possible/necessary.
* Completion Levels: