From 8e52784dcd48aeced8b76c754f97b6da54bb0465 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 10 Jan 2015 03:58:35 +0000 Subject: switch docs + website to olddoc 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. --- HACKING | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'HACKING') diff --git a/HACKING b/HACKING index acb9f9d..9b4da1b 100644 --- a/HACKING +++ b/HACKING @@ -57,10 +57,8 @@ programming experience will come in handy (or be learned) here. === Documentation -We use RDoc 2.5.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. @@ -114,7 +112,7 @@ don't email the git mailing list or maintainer with Unicorn patches :) 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: -- cgit v1.2.3-24-ge0c7