changeset 378:46e9ecf974a5

Docs: improve index page
author David Demelier <markand@malikania.fr>
date Sun, 18 Dec 2016 12:15:01 +0100
parents cd7270ec6c8e
children 4507a0895cd3
files doc/html/index.md
diffstat 1 files changed, 14 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/doc/html/index.md	Sun Dec 18 10:02:59 2016 +0100
+++ b/doc/html/index.md	Sun Dec 18 12:15:01 2016 +0100
@@ -12,14 +12,25 @@
   - [Build from sources](build/build-from-sources.html)
   - [Build options](build/build-options.html)
 
-# Running
+# Configuring & running
 
-Running irccd, configuration and command line options.
+## General topics
+
+Read the following sections to understand the configuration file format and in
+which directories they are located.
 
   - [Paths](irccd/paths.html)
+  - [Configuration file syntax](misc/configuration-syntax.html)
+
+## Irccd
+
+Configure and run `irccd` daemon.
+
   - [Configure irccd](irccd/configuring.html)
 
-And about irccdctl.
+## Irccdctl
+
+Everything about the `irccdctl` utility.
 
   - [Configure irccdctl](irccdctl/configuring.html)
   - [Irccdctl command line usage](irccdctl/usage.html)
@@ -56,4 +67,3 @@
 Miscellaneous documentation.
 
   - [Common patterns and formatting](misc/common-patterns-and-formatting.html)
-  - [Configuration file syntax](misc/configuration-syntax.html)