From 6bf7f40bfa6a9c3f2d1a046954de7ec09aeb1f97 Mon Sep 17 00:00:00 2001 From: ng0 Date: Fri, 3 Nov 2017 07:57:29 +0000 Subject: [PATCH] doc README --- doc/documentation/README.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/documentation/README.txt b/doc/documentation/README.txt index 6a34509a7..c3dda87c5 100644 --- 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: -- 2.25.1