From 885c2c9ee72921cf93a2b90f146a9244c4783dfd Mon Sep 17 00:00:00 2001 From: Simon Larcher Date: Thu, 18 Nov 2010 22:21:48 +0100 Subject: [PATCH] Minor changes on doc index and technical doc index Intended to make pages more user friendly. Formatted pages structures and added text --- doc/index.txt | 33 ++++++++++++++++++++++++--------- doc/technical/index.txt | 24 ++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 9 deletions(-) diff --git a/doc/index.txt b/doc/index.txt index ec326128d..ace219395 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,13 +1,28 @@ -Documentation -============= - -All kinds of documentation goes here, both user and developer documentation. - - * link:user/index.html[User Documentation] _(planned)_ - * link:{l}/media/index.html[Whitepapers and Presentations] - * link:design/index.html[Design Documents] - * link:technical/index.html[Technical and Documentation] +== Documentation [icon="warning.png"] WARNING: Website under construction +This documentation section contains documentation for both users and developpers. + +=== User + +The user manual containing the full reference for using Lumiera : + + * link:manual.html[User Manual] _(planned)_ + +=== Developper +Informations about the structure of Lumiera, they give an overview on the main components of the application : + + * link:design/index.html[Design Documents] + +Programming-oriented details about the functional layers of Lumiera as well as a Doxygen documentation : + + * link:technical/index.html[Technical Documents] + +=== Presentation documents +Documents that you can use as you wish to present or promote Lumiera : + + * link:white-papers-presentations.html[Whitepapers and Presentations] + + diff --git a/doc/technical/index.txt b/doc/technical/index.txt index 04bc29490..b3e1cbd26 100644 --- a/doc/technical/index.txt +++ b/doc/technical/index.txt @@ -1,3 +1,4 @@ +//// Technote Documentation ====================== @@ -10,4 +11,27 @@ Technote Documentation [icon="warning.png"] WARNING: Website under construction +//// +== Technical Documentation +[icon="warning.png"] +WARNING: Website under construction + +This documentation section contains technical documentation about Lumiera. + +=== Three Layers +The technical documentation is split in three parts, one for each of the three main layers of Lumiera. +You may want to read the link:design/index.html[Design Documents] first to get an overview of all the components. + +* link:gui/index.html[*Graphical User Interface*] : Documents about the default GTK GUI that comes with Lumiera. + +* link:proc/index.html[*Processing layer*] + +* link:backend/index.html[*Backend system*] + +=== Tools +.Development +* link:http://www.lumiera.org/doxy/[*Doxygen generated documentation*] : Complete reference for the code of Lumiera. + +.Building +* link:build/index.html[*Buildsystem*] : Installation & compilation tools, dependencies and packaging.