Make sure all pages have leading headings

bbatsov · bbatsov · commit 08b5863057bf · 2019-01-11T12:07:13.000+02:00
It's a bit lame that those headings appear in the sidebar, but
they make for nicer and more consistent pages.
diff --git a/doc/about/changelog.md b/doc/about/changelog.md
@@ -1 +1,3 @@
+# Changelog
+
 An extensive changelog is available [here](https://github.com/clojure-emacs/cider/blob/master/CHANGELOG.md).
diff --git a/doc/about/contributing.md b/doc/about/contributing.md
@@ -1,3 +1,5 @@
+# Contributing
+
 ## Issues
 
 Report issues and suggest features and improvements on the
diff --git a/doc/about/license.md b/doc/about/license.md
@@ -1,3 +1,5 @@
+# License
+
 Copyright (C) 2012-2016 Tim King, Phil Hagelberg, Bozhidar Batsov, Artur Malabarba and
 [contributors](https://github.com/clojure-emacs/cider/contributors).
 
diff --git a/doc/about/logo.md b/doc/about/logo.md
@@ -1,3 +1,5 @@
+# Logo
+
 CIDER's logo was created by [@tapeinosyne](https://github.com/tapeinosyne). You can find
 the logo in various formats
 [here](https://github.com/clojure-emacs/cider/tree/master/logo).
diff --git a/doc/about/support.md b/doc/about/support.md
@@ -1,3 +1,5 @@
+# Support
+
 CIDER currently has several official & unofficial support channels.
 
 For questions, suggestions and support refer to one of them.  Please, don't
diff --git a/doc/about/team.md b/doc/about/team.md
@@ -1,3 +1,5 @@
+# Team
+
 ## The Core Team
 
 The direction of the project is being stewarded by the CIDER core team. This
diff --git a/doc/additional_packages.md b/doc/additional_packages.md
@@ -1,3 +1,5 @@
+# Additional Packages
+
 There are many additional Emacs packages that can enhance your Clojure programming
 experience. The majority of the minor modes listed here should be enabled for both
 `cider-repl-mode` and `clojure-mode` for optimal effects.
diff --git a/doc/additional_resources.md b/doc/additional_resources.md
@@ -1,3 +1,5 @@
+# Additional Resources
+
 ## Quick reference
 
 A single-page quick reference PDF for CIDER commands is available
diff --git a/doc/caveats.md b/doc/caveats.md
@@ -1,3 +1,8 @@
+# Caveats
+
+CIDER is certainly not perfect and has some limitations that everyone
+should be aware of.
+
 ## ClojureScript limitations
 
 Currently, the following features are not supported for ClojureScript
diff --git a/doc/code_completion.md b/doc/code_completion.md
@@ -1,3 +1,5 @@
+# Code Completion
+
 CIDER provides intelligent code completion for both source buffers (powered by
 `cider-mode`) and REPL buffers.
 
diff --git a/doc/debugging.md b/doc/debugging.md
@@ -1,3 +1,5 @@
+# Debugging
+
 CIDER ships with a **powerful** interactive Clojure debugger inspired by Emacs's own
 [Edebug][]. You're going to love it!
 
@@ -9,7 +11,7 @@ CIDER ships with a **powerful** interactive Clojure debugger inspired by Emacs's
     [this issue](https://github.com/clojure-emacs/cider/issues/1416)
     for more details.
 
-## Debugging
+## Using the Debugger
 
 During normal CIDER development, it's common for a programmer to
 evaluate a form, often a function definition, by typing
diff --git a/doc/faq.md b/doc/faq.md
@@ -1,3 +1,5 @@
+# Frequently Asked Questions
+
 ## What does CIDER stand for?
 
 CIDER stands for **C**lojure **I**nteractive **D**evelopment **E**nvironment that **R**ocks.
diff --git a/doc/hacking_on_cider.md b/doc/hacking_on_cider.md
@@ -1,8 +1,10 @@
+# Hacking on CIDER
+
 This section explains the process of working with CIDER's codebase (e.g. to fix
 a bug or implement some new feature). It outlines the recommended workflows when
 working on the Emacs Lisp side (CIDER) and the Clojure side (`cider-nrepl`).
 
-## Hacking on CIDER
+## Hacking on CIDER (Elisp)
 
 ### Obtaining the source code
 
@@ -160,7 +162,7 @@ repository. The `evm` tool is available should you need to install some other
 specific build. However additional versions of Emacs will be discarded when
 you exit the docker container.
 
-## Hacking on cider-nrepl
+## Hacking on cider-nrepl (Clojure)
 
 ### Obtaining the code
 
diff --git a/doc/indent_spec.md b/doc/indent_spec.md
@@ -1,3 +1,5 @@
+# Indentation Specification
+
 ## Overview
 
 An indent spec can be used to specify intricate indentation rules for the more
diff --git a/doc/interactive_programming.md b/doc/interactive_programming.md
@@ -1,3 +1,7 @@
+# Interactive Programming
+
+## Overview
+
 Traditional programming languages and development environments often
 use a [Edit, Compile, Run
 Cycle](http://wiki.c2.com/?EditCompileLinkRun). In this environment,
@@ -115,7 +119,7 @@ Here's a list of `cider-mode`'s keybindings:
 !!! Tip
 
     `cider-find-var` has built-in support for [AVFS][].  AVFS is an a virtual
-    file system which allows seamless navigation within archives as if they were 
+    file system which allows seamless navigation within archives as if they were
     normal directories. When AVFS is mounted, `cider-find-var` automatically
     opens `jar` and `zip` files inside AVFS folder instead of attempting to
     uncompress the archive.
@@ -131,7 +135,7 @@ Here's a list of `cider-mode`'s keybindings:
     instance). You can also initialize the
     `avfsd` daemon directly like this:
 
-      `/usr/bin/avfsd -o allow_root -o intr -o sync_read .avfs` 
+      `/usr/bin/avfsd -o allow_root -o intr -o sync_read .avfs`
 
     [AVFS][] is not available on Windows but can be installed on MacOS with [some
     effort](http://blog.breadncup.com/tag/sunrise-commander/). Some other uses of
diff --git a/doc/managing_connections.md b/doc/managing_connections.md
@@ -1,11 +1,13 @@
+# Managing Connections
+
 !!! Note
 
     Because connections map one-to-one to REPL buffers, for the purpose of this
     section we use "REPL" and "connection" interchangeably.
 
 ## Sessions
 
-CIDER maintains a grouped view of opened connections through [Sesman]
+CIDER maintains a grouped view of opened nREPL connections through [Sesman]
 sessions. Each session is a collection of connections which share the same nREPL
 server.
 
diff --git a/doc/miscellaneous_features.md b/doc/miscellaneous_features.md
@@ -1,8 +1,10 @@
+# Miscellaneous Features
+
 As the infomercials always say, "But wait, there's more!" If
 simultaneous Clojure and ClojureScript REPLs, interactive programming,
 code completion, stacktrace navigation, test running, and debugging
 weren't enough for you, CIDER delivers several additional
-features. 
+features.
 
 ## Evaluating Clojure Code in the Minibuffer
 
@@ -255,7 +257,7 @@ Sometimes in your documentation strings, you'd like to be able to
 point other programmers at different definitions. If you specify the
 name of a definition in backticks (`` ` ``), CIDER will convert these
 references into live links when it displays the documentation string
-in the documentation buffer. 
+in the documentation buffer.
 
 If the name is in another namespace, then you'll have to include the
 fully qualified name in the docstring.
@@ -285,4 +287,3 @@ example, if you want to want to use
 ```
 
 ![CIDER See Also](images/cider_see_also.gif)
-
diff --git a/doc/navigating_stacktraces.md b/doc/navigating_stacktraces.md
@@ -1,3 +1,5 @@
+# Navigating Stacktraces
+
 CIDER comes with a powerful solution for dealing with Clojure
 stacktraces. CIDER presents stack traces in a special major mode,
 `cider-stacktrace-mode`, which gives you gives you some key features:
@@ -6,6 +8,8 @@ stacktraces. CIDER presents stack traces in a special major mode,
 - some handy ways to navigate to the cause of the exception
 - the ability to jump straight to code with a single keystroke
 
+## Keybindings
+
 Command                                | Keyboard shortcut                   | Description
 ---------------------------------------|-------------------------------------|--------------
 `cider-stacktrace-previous-cause`      |<kbd>M-p</kbd>                       | Move point to previous cause
@@ -26,6 +30,8 @@ Command                                | Keyboard shortcut                   | D
 `cider-stacktrace-show-only-project`   |<kbd>p</kbd>                         | Toggle display only project frames
 `cider-stacktrace-toggle-all`          |<kbd>a</kbd>                         | Toggle display of all frames
 
+## Working with Stacktraces
+
 By default, when an exception occurs, CIDER will display the exception
 in an error buffer using `cider-stacktrace-mode`. You can suppress
 this behavior, however:
@@ -67,6 +73,8 @@ To disable auto-selection of the error buffer when it's displayed:
 (setq cider-auto-select-error-buffer nil)
 ```
 
+## Filtering Stack Frames
+
 CIDER helps you cut through the clutter of Clojure stacktraces by
 allowing you to apply a list of filters using the
 `cider-stacktrace-default-filters` variable. Valid filter types
@@ -85,6 +93,8 @@ if they are both present.
 (setq cider-stacktrace-default-filters '(project))
 ```
 
+## Wrapping Error Messages
+
 Finally, CIDER can wrap error messages when they are displayed in a
 buffer to help improve their readability. CIDER uses
 `cider-stacktrace-fill-column` for this, which can take on three
diff --git a/doc/running_tests.md b/doc/running_tests.md
@@ -1,3 +1,5 @@
+# Running Tests
+
 The Clojure ecosystem provides a lot of support for test-driven
 development (TDD) and other test-centric patterns. First, Clojure
 provides a standardized framework for developing tests called
@@ -13,7 +15,7 @@ code that is failing to pass a given test.
     CIDER only supports clojure.test and other libraries
     providing integration with clojure.test.
 
-## Running Tests
+## Basic Usage
 
 CIDER has several functions that help you run all your tests or a
 selected subset of them. All of the CIDER test commands are available
@@ -30,7 +32,7 @@ You can run all *loaded* tests with <kbd>C-c C-t l</kbd> or
 
 If you invoke either of these commands with a prefix CIDER, will
 prompt for test selector filters and only run those tests that match
-the selector inclusions/exclusions. 
+the selector inclusions/exclusions.
 
 Test developers use selectors to define subsets of the total test
 suite that are run together for different testing tasks. For example
@@ -70,7 +72,7 @@ prompt for the selectors in the minibuffer. If you call this
 command with a prefix (<kbd>C-u C-c C-t C-s</kbd>) you can suppress
 the namespace inference logic as for <kbd>C-u C-c C-t C-n</kbd>
 
-Finally, you can execute the specific test at the point using 
+Finally, you can execute the specific test at the point using
 <kbd>C-c C-t t</kbd> or <kbd>C-c C-t C-t</kbd>.
 
 ## Interacting with Test Result Reports
diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md
@@ -1,3 +1,5 @@
+# Troubleshooting
+
 In case you run into issues here are a few tips that can help you diagnose the
 problem.
 
diff --git a/doc/up_and_running.md b/doc/up_and_running.md
@@ -1,3 +1,5 @@
+# Up and Running
+
 To use CIDER, you'll need to connect it to a running nREPL server that
 is associated with your program. Most Clojure developers use standard
 build tooling such as Leiningen, Boot, or Gradle, and CIDER can

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# Changelog`
	`2`	`+`
`1`	`3`	`An extensive changelog is available [here](https://github.com/clojure-emacs/cider/blob/master/CHANGELOG.md).`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Contributing`
	`2`	`+`
`1`	`3`	`## Issues`
`2`	`4`
`3`	`5`	`Report issues and suggest features and improvements on the`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# License`
	`2`	`+`
`1`	`3`	`Copyright (C) 2012-2016 Tim King, Phil Hagelberg, Bozhidar Batsov, Artur Malabarba and`
`2`	`4`	`[contributors](https://github.com/clojure-emacs/cider/contributors).`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Logo`
	`2`	`+`
`1`	`3`	`CIDER's logo was created by [@tapeinosyne](https://github.com/tapeinosyne). You can find`
`2`	`4`	`the logo in various formats`
`3`	`5`	`[here](https://github.com/clojure-emacs/cider/tree/master/logo).`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Support`
	`2`	`+`
`1`	`3`	`CIDER currently has several official & unofficial support channels.`
`2`	`4`
`3`	`5`	`For questions, suggestions and support refer to one of them. Please, don't`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Team`
	`2`	`+`
`1`	`3`	`## The Core Team`
`2`	`4`
`3`	`5`	`The direction of the project is being stewarded by the CIDER core team. This`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Additional Packages`
	`2`	`+`
`1`	`3`	`There are many additional Emacs packages that can enhance your Clojure programming`
`2`	`4`	`experience. The majority of the minor modes listed here should be enabled for both`
`3`	`5`	`cider-repl-mode` and `clojure-mode` for optimal effects.
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Additional Resources`
	`2`	`+`
`1`	`3`	`## Quick reference`
`2`	`4`
`3`	`5`	`A single-page quick reference PDF for CIDER commands is available`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Code Completion`
	`2`	`+`
`1`	`3`	`CIDER provides intelligent code completion for both source buffers (powered by`
`2`	`4`	`cider-mode`) and REPL buffers.
`3`	`5`