documentation

developer documentation
Log | Files | Refs | README | git clone https://git.ne02ptzero.me/git/documentation

commit a42e2b99d78923ffc8cdd1861dea2f838cfabf88
parent 30e072d7b95001fb41cf265bfc4891942631985f
Author: Ne02ptzero <louis@ne02ptzero.me>
Date:   Wed,  7 Dec 2016 10:16:35 +0100

Add(Introduction): Better documentation structure

Diffstat:
Adocs/Introduction.md | 18++++++++++++++++++
Mdocs/index.md | 26++++++++++++++------------
Mmkdocs.yml | 1+
3 files changed, 33 insertions(+), 12 deletions(-)

diff --git a/docs/Introduction.md b/docs/Introduction.md @@ -0,0 +1,18 @@ +# Introduction + +## What is Morphux ? +Morphux is a [Linux](https://en.wikipedia.org/wiki/Linux) distribution, +aimed to be efficient and portable. + +TBD + +## What can I do with Morphux ? +TBD + +## What I can't do with Morphux ? +TBD + +## Philosophy +TBD + + diff --git a/docs/index.md b/docs/index.md @@ -1,19 +1,21 @@ # Morphux Documentation -## What is Morphux ? -Morphux is a [Linux](https://en.wikipedia.org/wiki/Linux) distribution, -aimed to be efficient and portable. +Hey there ! -TBD +Welcome to the Morphux documentation. Here, you can find multiples information +about how Morphux works and how to work with it. -## What can I do with Morphux ? -TBD +If you have no idea what Morphux is, you should problably begin by the +[Introduction](Introduction.md) -## What I can't do with Morphux ? -TBD +If you're looking for developer documentation, you should go +[Here](https://dev-docs.morphux.org) -## Philosophy -TBD +## What's in this Documentation +This Documentation is separated in different categories: -## How to read this Documentation -TBD +- [Introduction](Introduction.md): An introduction to Morphux and Linux, +how it works, and what you can / can't do with it. +- [Packages](Packages.md): How the software work in Morphux +- [Infrastructure](Infrastructure.md): A complete server Infrastructure of +Morphux (TODO: Move to the dev Documentation) diff --git a/mkdocs.yml b/mkdocs.yml @@ -1,6 +1,7 @@ site_name: Morphux Documentation pages: - Home: index.md + - Introduction: Introduction.md - Packages: Package.md - Infrastructure: Infrastructure.md theme: null