[Checkins] SVN: grok/branches/neanderthal-reference-documentation/doc/reference/ added TODO list and updated README to reflect that we've migrated to ReST

Luciano Ramalho luciano at ramalho.org
Tue Oct 2 10:55:28 EDT 2007


Log message for revision 80501:
  added TODO list and updated README to reflect that we've migrated to ReST
  

Changed:
  U   grok/branches/neanderthal-reference-documentation/doc/reference/README.txt
  A   grok/branches/neanderthal-reference-documentation/doc/reference/TODO.txt

-=-
Modified: grok/branches/neanderthal-reference-documentation/doc/reference/README.txt
===================================================================
--- grok/branches/neanderthal-reference-documentation/doc/reference/README.txt	2007-10-02 14:54:19 UTC (rev 80500)
+++ grok/branches/neanderthal-reference-documentation/doc/reference/README.txt	2007-10-02 14:55:28 UTC (rev 80501)
@@ -2,5 +2,7 @@
 The grok reference manual
 =========================
 
-NOTE: The Grok reference manual is in the process of being migrated to a
-RestructuredText infrastructure.
+NOTE TO DOC WRITERS: Although the caveman metaphors in the tests is nice and cute, maybe in the reference documentation they don't help newcomers to understand practical use cases. More realistic examples would be useful.
+
+
+

Added: grok/branches/neanderthal-reference-documentation/doc/reference/TODO.txt
===================================================================
--- grok/branches/neanderthal-reference-documentation/doc/reference/TODO.txt	                        (rev 0)
+++ grok/branches/neanderthal-reference-documentation/doc/reference/TODO.txt	2007-10-02 14:55:28 UTC (rev 80501)
@@ -0,0 +1,4 @@
+- replace caveman examples with more realistic ones when possible
+
+- document the conventional (or default) behaviour when directives are not spelled out
+



More information about the Checkins mailing list