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/emacs/dired/README.org

@@ -1,49 +1,75 @@
-#+TITLE:   emacs/dired
-#+DATE:    May 27, 2018
-#+SINCE:   v2.0
-#+STARTUP: inlineimages
+# -*- mode: doom-docs-org -*-
+#+title:    :emacs dired
+#+subtitle: Making dired pretty [functional]
+#+created:  February 20, 2017
+#+since:    2.0.0
 
-* Table of Contents :TOC_3:noexport:
-- [[#description][Description]]
-  - [[#module-flags][Module Flags]]
-  - [[#plugins][Plugins]]
-- [[#prerequisites][Prerequisites]]
-- [[#keybindings][Keybindings]]
-  - [[#ranger][Ranger]]
+* Description :unfold:
+This module provides reasonable defaults and augmentations for dired.
 
-* Description
-This module provides configuration for dired.
+** Maintainers
+/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
 
-** Module Flags
-+ =+ranger= Enables dired to be more like [[https://github.com/ranger/ranger][ranger]].
-+ =+icons= Enables the display of fancy icons depending on file types in dired
-  buffers.
+** Module flags
+- +icons ::
+  Enables the display of fancy icons depending on file types in dired buffers.
+- +ranger ::
+  Enables dired to be more like [[https://github.com/ranger/ranger][ranger]].
 
-** Plugins
-+ [[https://github.com/purcell/diredfl][diredfl]]
-+ [[https://github.com/stsquad/dired-rsync][dired-rsync]]
-+ [[https://github.com/dgutov/diff-hl/][diff-hl]]
-+ [[https://github.com/yqrashawn/fd-dired][fd-dired]]
-+ =+ranger=
-  + [[https://github.com/ralesi/ranger.el][ranger]]
-+ =+icons=
-  + [[https://github.com/jtbm37/all-the-icons-dired][all-the-icons-dired]]
+** Packages
+- [[doom-package:][all-the-icons-dired]] if [[doom-module:][+icons]]
+- [[doom-package:][diff-hl]]
+- [[doom-package:][diredfl]]
+- [[doom-package:][dired-rsync]]
+- [[doom-package:][fd-dired]]
+- [[doom-package:][ranger]] if [[doom-module:][+ranger]]
 
-* Prerequisites
-This module has no prerequisites *except on BSDs* where =GNU ls= (~gls~) is
-needed for it to work properly (Doom doctor will notify you if it is missing).
+** TODO Hacks
+#+begin_quote
+ 🔨 This module's hacks haven't been documented yet. [[doom-contrib-module:][Document them?]]
+#+end_quote
 
-* Keybindings
-| Keybind   | Description                  |
-|-----------+------------------------------|
-| =SPC f d= | Find directory with dired    |
-| =q=       | Exit dired buffer            |
-| =C-c C-r= | Run =dired-rsync=            |
-| =C-c C-e= | Rename entries with =wdired= |
+** 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 has no requirements *except on BSDs* like MacOS or FreeBSD, where
+=GNU ls= (aka ~gls~) is required.
+
+* TODO Usage
+#+begin_quote
+ 🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
+#+end_quote
+
+| Keybind | Description                |
+|---------+----------------------------|
+| [[kbd:][SPC f d]] | Find directory with dired  |
+| [[kbd:][q]]       | Exit dired buffer          |
+| [[kbd:][C-c C-r]] | Run [[doom-package:][dired-rsync]]            |
+| [[kbd:][C-c C-e]] | Rename entries with [[doom-package:][wdired]] |
 
 Other keybindings can be found on the official [[https://www.gnu.org/software/emacs/refcards/pdf/dired-ref.pdf][Dired reference card]].
 
 ** Ranger
-If =+ranger= is enabled often a buffer will be opened in minimal ranger mode
-(deer-mode). In this case =z P= can be used to toggle between full ranger and
-deer-mode.
+If [[doom-module:][+ranger]] is enabled often a buffer will be opened in minimal ranger mode
+(~deer-mode~). In this case [[kbd:][z P]] can be used to toggle between full ranger and
+~deer-mode~.
+
+* TODO Configuration
+#+begin_quote
+ 🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
+#+end_quote
+
+* 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