Fix documentation issues with ruby, rails, and swift layers

See syl20bnr#9476
Alexander-Miller · Sep 17, 2017 · 510d460 · 510d460
1 parent ff8fef3
commit 510d460
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 15 deletions.
diff --git a/layers/+frameworks/ruby-on-rails/README.org b/layers/+frameworks/ruby-on-rails/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#install][Install]]
 - [[#key-bindings][Key bindings]]
   - [[#code-navigation][Code Navigation]]
@@ -14,6 +15,13 @@
 * Description
 This layer aims at providing support for the Ruby on Rails framework.
 
+** Features:
+   - Quick file navigation with with [[https://github.com/asok/projectile-rails][projectile-rails]]
+   - Run server
+   - Run generators
+   - Rake runner
+   - Interactive Rails console
+
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to
 add =ruby-on-rails= to the existing =dotspacemacs-configuration-layers= list in this

diff --git a/layers/+lang/ruby/README.org b/layers/+lang/ruby/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#install][Install]]
   - [[#prerequisites][Prerequisites]]
   - [[#ruby-version-management][Ruby version management]]
@@ -21,13 +22,15 @@
 - [[#layer-options][Layer options]]
 
 * Description
-This layer provides support for the Ruby language with the following features:
-- version manager (rbenv, rvm or chruby)
-- integration with bundler
-- test runner (ruby-test and rspec)
-- rake runner
-- linter (rubocop)
-- interactive REPL and code navigation (robe)
+This layer provides support for the Ruby programming language.
+
+** Features:
+   - Version manager (rbenv, rvm or chruby)
+   - Integration with bundler
+   - Test runner (ruby-test and rspec)
+   - Rake runner
+   - Linter (rubocop)
+   - Interactive REPL and code navigation (robe)
 
 * Install
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to

diff --git a/layers/+lang/swift/README.org b/layers/+lang/swift/README.org
@@ -4,6 +4,7 @@
 
 * Table of Contents                                         :TOC_4_gh:noexport:
 - [[#description][Description]]
+  - [[#features][Features:]]
 - [[#install][Install]]
 - [[#usage-information][Usage information]]
 - [[#key-bindings][Key bindings]]
@@ -14,14 +15,12 @@
 This layer adds support for Apple's Swift programming language, used as a
 general purpose scripting language.
 
-It relies on the [[https://github.com/swift-emacs/swift-mode][swift-mode]] major-mode* for Emacs 24.4 or later, to provide the
-following features:
-
-- Syntax highlighting
-- Indentation
-- Code navigation using =imenu= (built-in)
-- Automatic syntax checking with =flycheck= (available with the
-  =syntax-checking= layer)
+** Features:
+   - Syntax highlighting with [[https://github.com/swift-emacs/swift-mode][swift-mode]]
+   - Indentation
+   - Code navigation using =imenu= (built-in)
+   - Automatic syntax checking with =flycheck= (available with the
+     =syntax-checking= layer)
 
 * Install
 First check that you are able to run this from the command line: