taler-docs

commit 22fce4576d972bbd091448092e19ea7bf259ae8e
parent aa9233f81df5cd45ee0d69310e2d587517a2a46e
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
Date:   Mon, 14 Dec 2020 02:02:20 -0500

add Tips section to frags/README.md

Diffstat:
M
frags/README.md
 | 
6
++++++

1 file changed, 6 insertions(+), 0 deletions(-)
diff --git a/frags/README.md b/frags/README.md
@@ -10,3 +10,9 @@ If the fragment includes header lines, you MUST include it at top-level
 Otherwise, it can be included at either top-level or indented.
 
 See <https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment>.
+
+Tips:
+
+- Don't put index entries in frags/* files.
+  (They will result in a Sphinx warning.)
+  Instead, keep them in the *including* text.