From 9077dec275cc50655dc7b20a457bb78fee08619e Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Tue, 27 Dec 2016 14:17:39 +0100 Subject: [PATCH] Add text to ldoc index This adds a short text with some hopefully helpful pointers to the top of the index.html generated by ldoc. Signed-off-by: Uli Schlachter --- docs/config.ld | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/config.ld b/docs/config.ld index 69e87bf7f..5bf4eae70 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -15,6 +15,16 @@ backtick_references=true merge=true use_markdown_titles=true wrap=true +full_description = [[ +Welcome to the documentation for the awesome window manager. Below you find an +overview of the individual parts which links to the full documentation. + +If you are a new user, you may want to read @{07-my-first-awesome.md} to get +started. In @{05-awesomerc.md}, the default configuration is explained. + +If you already used awesome in the past, @{89-NEWS.md} and @{17-porting-tips.md} +should be useful for you. +]] topics={ '00-authors.md', '01-readme.md',