Fix various documentation errors and inconsistencies

Fixes documentation errors from issue syl20bnr#9476 in the following layers... * syntax-checking * games * xkcd * keyboard-layout * racket
benreyn · Oct 4, 2017 · 289158f · 289158f
1 parent 71a0d41
commit 289158f
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 15 deletions.
diff --git a/layers/+checkers/syntax-checking/README.org b/layers/+checkers/syntax-checking/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#install][Install]]
   - [[#layer][Layer]]
   - [[#enablingdisabling-tooltips][Enabling/Disabling tooltips]]
@@ -14,6 +15,10 @@
 * Description
 This layer provides on the fly syntax checking using [[http://www.flycheck.org/][Flycheck]].
 
+** Features:
+   - Automatic syntax checking with [[http://www.flycheck.org/][Flycheck]]
+   - Tooltip syntax errors with =popwin=
+
 * Install
 ** Layer
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to

diff --git a/layers/+fun/games/README.org b/layers/+fun/games/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#install][Install]]
 - [[#games-instructions][Games instructions]]
   - [[#2048][2048]]
@@ -16,12 +17,12 @@
 * Description
 This layer allows you to play evilified games in spacemacs.
 
-The games available now are:
-- 2048-game
-- Pacmacs (Pacman for Emacs)
-- Sudoku
-- Tetris
-- Typit
+** Features:
+  - 2048-game
+  - Pacmacs (Pacman for Emacs)
+  - Sudoku
+  - Tetris
+  - Typit
 
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to

diff --git a/layers/+fun/xkcd/README.org b/layers/+fun/xkcd/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#install][Install]]
 - [[#key-bindings][Key Bindings]]
   - [[#tell-me-how-to-spawn-the-xkcd-greatness][Tell me how to spawn the xkcd greatness!!]]
@@ -12,11 +13,11 @@
 * Description
 This layer adds a [[http://xkcd.com/][xkcd]] navigation mode using [[https://github.com/vibhavp/emacs-xkcd][emacs-xkcd]].
 
-Features:
-- Load a random xkcd
-- Show the text in the modeline
-- Open explanation and current comic in browser
-- Cache the comics in =.cache/xkcd=
+** Features:
+  - Load a random xkcd
+  - Show the text in the modeline
+  - Open explanation and current comic in browser
+  - Cache the comics in =.cache/xkcd=
 
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to

diff --git a/layers/+intl/keyboard-layout/README.org b/layers/+intl/keyboard-layout/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#installation][Installation]]
 - [[#configuration][Configuration]]
   - [[#enabledisable-package-configurations][Enable/Disable package configurations]]
@@ -22,6 +23,10 @@
 * Description
 This layer configures some key bindings in Spacemacs, to make it compatible with
 keyboard layouts that differs from the traditional =en-us= =QWERTY= layout.
+** Features:
+   - Support alernative keyboard layouts within spacemacs
+   - Remap navigation commands to the homerow of your chosen layout
+   - Remap missing commands automatically to elsewhere in the layout
 
 * Installation
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to

diff --git a/layers/+lang/racket/README.org b/layers/+lang/racket/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#install][Install]]
 - [[#key-bindings][Key Bindings]]
   - [[#navigation][Navigation]]
@@ -15,6 +16,11 @@
 * Description
 Adds support for the [[http://racket-lang.org/][Racket]] programming language.
 
+** Features:
+   - Syntax highlighting with =racket-mode=
+   - Test runner
+   - Interactive REPL
+   - Code navigation with =gtags=
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to
 add =racket= to the existing =dotspacemacs-configuration-layers= list in this

diff --git a/layers/+os/osx/README.org b/layers/+os/osx/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#philosophy][Philosophy]]
 - [[#install][Install]]
   - [[#layer][Layer]]
@@ -15,10 +16,10 @@
 
 * Description
 Spacemacs is not just emacs+vim. It can have OSX keybindings too! This layer
-globally defines common OSX keybindings. ~⌘~ is set to ~hyper~ and ~⌥~ is set to
-~meta~. Aside from that, there's nothing much, really.
-
-While in =dired= this layer will try to use =gls= instead of =ls=.
+globally defines common OSX keybindings.
+** Features:
+  - ~⌘~ is set to ~hyper~ and ~⌥~ is set to ~meta~
+  - In =dired= use =gls= instead of =ls=
 
 * Philosophy
 While this layer enables common OSX bindings, it does not implement OSX