about summary refs log tree commit homepage
path: root/HACKING
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2015-01-10 04:27:20 +0000
committerEric Wong <e@80x24.org>2015-01-10 04:34:03 +0000
commitc0d431d22ee1e2e69338189f9ce5a4b4abc07e6e (patch)
tree007022f0869232880d196efe6353aef71d0ba449 /HACKING
parent633b984a41cc3b036b47982ad72b5658ec54c918 (diff)
downloadrainbows-c0d431d22ee1e2e69338189f9ce5a4b4abc07e6e.tar.gz
wrongdoc was difficult to maintain because of the tidy-ffi
dependency and the HTML5 changes in Darkfish could not be
handled well by Tidy.

olddoc is superior as it generates leaner HTML which loads faster,
requires less scrolling and less processing power to render.
Aesthetic comparisons are subjective of course but completely
unimportant compared to speed and accessibility.

The presence of images and CSS on the old (Darkfish-based) site
probably set unreasonable expectations as to my ability and
willingness to view such things.  No more, the new website is
entirely simple HTML which renders well with even the wimpiest
browser (hell, olddoc even tries to generate readable raw HTML).
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING8
1 files changed, 3 insertions, 5 deletions
diff --git a/HACKING b/HACKING
index 946887d..27c87a4 100644
--- a/HACKING
+++ b/HACKING
@@ -6,10 +6,8 @@ All tests are written in POSIX shell.  See README file in the t/ directory.
 
 === Documentation
 
-We use RDoc 3.9.x with Darkfish for documentation as much as possible,
-if you're on Ruby 1.8 you want to install the latest "rdoc" gem.  Due to
-the lack of RDoc-to-manpage converters we know about, we're writing
-manpages in Markdown and converting to troff/HTML with Pandoc.
+Due to the lack of RDoc-to-manpage converters we know about, we're
+writing manpages in Markdown and converting to troff/HTML with Pandoc.
 
 Please wrap documentation at 72 characters-per-line or less (long URLs
 are exempt) so it is comfortably readable from terminals.
@@ -48,7 +46,7 @@ Please Cc: everyone on replies, as not everyone is subscribed.
 
 In order to build the gem, you must install the following components:
 
- * wrongdoc
+ * olddoc (RubyGem)
  * pandoc
 
 You can build the Unicorn gem with the following command: