Started on hacking doc

2014-02-01 13:43:58 -05:00 · 2014-02-01 13:43:58 -05:00 · a948936740
parent 143a7102c6
commit a948936740
2 changed files with 11 additions and 2 deletions
--- a/doc/TODO.txt
+++ b/doc/TODO.txt
@ -226,8 +226,6 @@ o Visitation refactoring
 DOCUMENTATION
 -------------
 o Auto-generate API documentation instead of, in addition to or combined with, the wikibooks docs.
-o Write checklists for typical extension work (add new module, add new function)
-  -> syntax highlighter, test files, examples, documentation (external editor modes)
 o Clarify include/use better in the wikibook docs (e.g. that use'd modules have to be self-contained)

 TESTING
--- a/doc/hacking.txt
+++ b/doc/hacking.txt
@ -0,0 +1,11 @@
+# Add new function/module
+
+* Implement
+* Add test
+* Modules: Add example
+* Document:
+   * wikibooks
+   * cheatsheet
+   * Modules: tooltips (editor.cc)
+   * External editor modes
+   * Add to RELEASE_NOTES