index: add table of contents

[notmuch-wiki] / index.mdwn

diff --git a/index.mdwn b/index.mdwn
index 4df11a4927438c0faa016f8bd184437bb814ddfd..7ed986ae35b9afb6a3058ef53f12639abc4b4192 100644 (file)
--- a/index.mdwn
+++ b/index.mdwn
@@ -16,6 +16,8 @@ email, but don't want to give a 3rd-party access to your email...
 
 Then notmuch may be exactly what you've been looking for.
 
+[[!toc levels=2]]
+
 ## Why is it named Notmuch?
 
 * "Not much mail" is what Notmuch thinks about your email
@@ -51,12 +53,26 @@ Then notmuch may be exactly what you've been looking for.
 
 [[The latest news from notmuch|news]]
 
-## Documentation
+## Getting Started
 
-To get started with notmuch, just run "notmuch" at the command line.
+To get started with Notmuch, just run "notmuch" at the command line.
 This command will walk you through initial setup, including specifying
 the location of your mail store and how to start the initial indexing.
-After that, come back and checkout our documentation:
+
+For a little more detailed guide, see [[Getting Started with
+Notmuch|getting-started]].
+
+## Email Clients and Front Ends
+
+Notmuch ships with a powerful set of [[command-line tools|manpages]], an
+[[email client for Emacs|notmuch-emacs]], another
+[client for vim](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
+and a [[Mutt integration script|notmuch-mutt]].
+
+There are also many other [[email clients and frontends|frontends]] based on
+Notmuch.
+
+## Documentation
 
   * [[Notmuch manual pages|manpages]]
   * [[General how-tos|howto]]
@@ -64,24 +80,15 @@ After that, come back and checkout our documentation:
   * [[Searching]]
   * [[Excluding and deleting messages|excluding]]
   * [[Initial tagging|Initial_Tagging]]
-  * [[Tips for using notmuch within Emacs|emacstips]]
-  * [[Remote usage|remoteusage]]
+  * Tips for using Notmuch with [[Emacs|emacstips]], [[Vim|vimtips]], and [[Mutt|mutttips]]
+  * [[Emacs remote usage|remoteusage]]
   * [[Performance|performance]]
   * [[References|references]]
+  * [[Notmuch Library Language Bindings|bindings]]
 
 Apart from the wiki, help is available via email and on IRC (see
 below).  Join the mailing list.  Read the archives.  Ask questions.
 
-## Email clients and front ends
-
-Notmuch ships with a powerful set of [[command-line tools|manpages]], an
-[[email client for Emacs|emacstips]], another
-[client for vim](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
-and a [[Mutt integration script|notmuch-mutt]].
-
-There are also many other [[email clients and frontends|frontends]] based on
-Notmuch. And a few tips about integrating it with [[Mutt|mutttips]] and [[Vim|vimtips]].
-
 ## Screenshots
 
 * [[Emacs UI screenshots|screenshots]]
@@ -91,7 +98,8 @@ Notmuch. And a few tips about integrating it with [[Mutt|mutttips]] and [[Vim|vi
 [Notmuch source releases](http://notmuchmail.org/releases/) are available as
 source tar balls.
 
-Notmuch is packaged for at least the following distributions:
+Notmuch is packaged for at least the following operating systems and
+distributions:
 
 * [Arch Linux](https://www.archlinux.org/packages/?q=notmuch)
 * [Debian](http://packages.debian.org/search?keywords=notmuch)
@@ -99,11 +107,10 @@ Notmuch is packaged for at least the following distributions:
 * [Gentoo](http://packages.gentoo.org/package/net-mail/notmuch)
 * [NetBSD](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/notmuch/README.html)
 * [openSUSE](https://build.opensuse.org/search?search_text=notmuch)
+* OS X [Homebrew](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/notmuch.rb), [MacPorts](https://www.macports.org/ports.php?by=name&substr=notmuch), or [pkgsrc](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/notmuch/README.html).
 * [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
 * [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
 
-Notmuch can be installed on OS X using [Homebrew](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/notmuch.rb), [MacPorts](https://www.macports.org/ports.php?by=name&substr=notmuch), or [pkgsrc](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/notmuch/README.html).
-
 ## Development and Contributing
 
 All of the code for Notmuch is available as [free
@@ -132,7 +139,7 @@ Contributions, such as patches, to Notmuch are most welcome. Please refer to the
 
 For hints about troubleshooting and bug reporting see [[bugs]].
 
-For a list of known bugs see the [[nmbug status page|http://nmbug.tethera.net/status/#Bugs]]
+For a list of known bugs see the [[nmbug status page|http://nmbug.notmuchmail.org/status/#Bugs]].
 
 ## Contact: Email & IRC
 
@@ -152,8 +159,9 @@ format which is convenient for reading the archives within notmuch
 itself.
 
 If you prefer real-time chat, there is often someone on the
-[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC
-channel.
+[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel. Don't
+ask if you can ask a question, just ask, and please wait for an answer, we might
+not be in your timezone.
 
 ## Feature ideas
 
@@ -164,6 +172,6 @@ for non-subscribers.
 
 ## Website
 
-This wiki is maintained using [ikiwiki](http://ikiwiki.info). Here are
-[[instructions on how to edit the wiki|wikiwriteaccess]]. The wiki contents are
-mostly [[dual licensed under CC-BY-SA-3.0 and GPLv3+|COPYING]].
+This website is a wiki, maintained using [ikiwiki](http://ikiwiki.info). Here
+are [[instructions on how to edit the wiki|wikiwriteaccess]]. The wiki contents
+are mostly [[dual licensed under CC-BY-SA-3.0 and GPLv3+|COPYING]].