merge: rewrite-docs

I've omitted docs/*.org from this merge, as there is still work left to
do there, but I am pushing the module docs early so folks can benefit
from the new docs sooner.

modules/lang/crystal/README.org

@@ -1,62 +1,66 @@
-#+TITLE:   lang/crystal
-#+DATE:    January 16, 2017
-#+SINCE:   v1.3
-#+STARTUP: inlineimages nofold
+# -*- mode: doom-docs-org -*-
+#+title:    :lang crystal
+#+subtitle: Ruby at the speed of C
+#+created:  January 16, 2017
+#+since:    1.3
 
-* Table of Contents :TOC_3:noexport:
-- [[#description][Description]]
-  - [[#maintainers][Maintainers]]
-  - [[#module-flags][Module Flags]]
-  - [[#plugins][Plugins]]
-- [[#prerequisites][Prerequisites]]
-  - [[#crystal][Crystal]]
-    - [[#macos][MacOS]]
-    - [[#arch][Arch]]
-  - [[#icr-repl][ICR (REPL)]]
-- [[#features][Features]]
-- [[#configuration][Configuration]]
-- [[#troubleshooting][Troubleshooting]]
-
-* Description
+* Description :unfold:
 This modules adds [[https://crystal-lang.org/][crystal]] support.
 
-+ Syntax-checking (~flycheck~)
-+ REPL (~inf-crystal~)
+- Syntax-checking (~flycheck~)
+- REPL (~inf-crystal~)
 
 ** Maintainers
 This module has no dedicated maintainers.
 
-** Module Flags
-This module provides no flags.
+** Module flags
+/This module has no flags./
 
-** Plugins
-+ [[https://github.com/crystal-lang-tools/emacs-crystal-mode/][crystal-mode]]
-+ [[https://github.com/brantou/inf-crystal.el/][inf-crystal]]
-+ if ~:checkers syntax~ is enabled
-  - [[https://github.com/crystal-lang-tools/emacs-crystal-mode/][flycheck-crystal]]
-  - [[https://github.com/crystal-ameba/ameba.el/][flycheck-ameba]]
+** Packages
+- [[doom-package:][crystal-mode]]
+- [[doom-package:][inf-crystal]]
+- if [[doom-module:][:checkers syntax]]
+  - [[doom-package:][flycheck-ameba]]
+  - [[doom-package:][flycheck-crystal]]
+
+** Hacks
+/No hacks documented for this module./
+
+** TODO Changelog
+# This section will be machine generated. Don't edit it by hand.
+/This module does not have a changelog yet./
+
+* Installation
+[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
+
+This module requires:
+- [[https://crystal-lang.org/install/][The crystal compiler]]
+- [[https://github.com/crystal-community/icr][ICR]], for the REPL
 
-* Prerequisites
 ** Crystal
-you need to install [[https://crystal-lang.org/install/][the crystal compiler]].
-
-*** MacOS
-#+begin_src shell
-brew install crystal
-#+end_src
-
-*** Arch
-#+begin_src shell
-sudo pacman -S crystal shards
-#+end_src
+- MacOS: ~$ brew install crystal~
+- Arch Linux: ~$ pacman -S crystal shards~
 
 ** ICR (REPL)
-you need to install [[https://github.com/crystal-community/icr][ICR]].
+[[https://github.com/crystal-community/icr#installation][Installation instructions]].
+
+* TODO Usage
+#+begin_quote
+ 🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
+#+end_quote
 
-* TODO Features
-# An in-depth list of features, how to use them, and their dependencies.
 * TODO Configuration
-# How to configure this module, including common problems and how to address them.
+#+begin_quote
+ 🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
+#+end_quote
 
-* TODO Troubleshooting
-# Common issues and their solution, or places to look for help.
+* Troubleshooting
+/There are no known problems with this module./ [[doom-report:][Report one?]]
+
+* Frequently asked questions
+/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
+
+* TODO Appendix
+#+begin_quote
+ 🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
+#+end_quote