Improve docs structure

README.md

@@ -17,7 +17,7 @@
   <p align="center">
     The ultimate tool to interact with your audience.
     <br />
-    <a href="https://github.com/ClaperCo/Claper/wiki"><strong>Explore the wiki »</strong></a>
+    <a href="https://docs.claper.co"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://github.com/ClaperCo/Claper/issues">Report Bug</a>
@@ -71,7 +71,7 @@ You can also use Docker to easily run a Postgres instance:
 
 ### Configuration
 
-You can find all configuration options in [the wiki](https://github.com/ClaperCo/Claper/wiki/Configuration).
+You can find all configuration options in [the docs](https://docs.claper.co/configuration.html).
 
 ### Installation
 

guides/introduction/configuration.md

@@ -1,3 +1,5 @@
+# Configuration
+
 ## Environment file
 
 All configuration used by the app is stored in the `.env` file. You can find an example file in `.env.sample`, but you should copy it to `.env` and fill it with your own values (described below).

guides/introduction/installation.md

@@ -0,0 +1,55 @@
+# Installation
+
+## Prerequisites
+
+To run Claper on your local environment you need to have:
+* Postgres >= 9
+* Elixir >= 1.13.2
+* Erland >= 24
+* NPM >= 6.14.17
+* NodeJS >= 14.19.2
+* Ghostscript >= 9.5.0 (for PDF support)
+* Libreoffice >= 6.4 (for PPT/PPTX support)
+
+You can also use Docker to easily run a Postgres instance:
+```sh
+  docker run -p 5432:5432 -e POSTGRES_PASSWORD=claper -e POSTGRES_USER=claper -e POSTGRES_DB=claper --name claper-db -d postgres:9
+  ```
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/ClaperCo/Claper.git
+   ```
+2. Install dependencies
+   ```sh
+   mix deps.get
+   ```
+3. Migrate your database
+   ```sh
+   mix ecto.migrate
+   ```
+4. Install JS dependencies
+   ```sh
+   cd assets && npm i
+   ```
+5. Allow execution of startup file
+   ```sh
+   chmod +x ./start.sh
+   ```
+6. Start Phoenix endpoint with
+   ```sh
+   ./start.sh
+   ```
+
+Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
+
+If you have configured `MAIL` to `local`, you can access to the mailbox at [`localhost:4000/dev/mailbox`](http://localhost:4000/dev/mailbox).
+
+
+## Using Docker
+
+You can build the app with Docker:
+```sh
+docker build -t claper .
+docker run -p 4000:4000 -d claper
+```

guides/introduction/overview.md

@@ -0,0 +1,24 @@
+# Overview
+
+![Contributors][contributors-shield]
+![Forks][forks-shield]
+![Stargazers][stars-shield]
+![Issues][issues-shield]
+![MIT License][license-shield]
+
+<img src="assets/logo-large.png" width="300"/>
+
+Claper turns your presentations into an interactive, engaging and exciting experience.
+
+Claper has a two-sided mission:
+- The first one is to help these people presenting an idea or a message by giving them the opportunity to make their presentation unique and to have real-time feedback from their audience.
+- The second one is to help each participant to take their place, to be an actor in the presentation, in the meeting and to feel important and useful.
+
+
+![](assets/preview.png)
+
+[contributors-shield]: https://img.shields.io/github/contributors/ClaperCo/Claper.svg?style=for-the-badge
+[forks-shield]: https://img.shields.io/github/forks/ClaperCo/Claper.svg?style=for-the-badge
+[stars-shield]: https://img.shields.io/github/stars/ClaperCo/Claper.svg?style=for-the-badge
+[issues-shield]: https://img.shields.io/github/issues/ClaperCo/Claper.svg?style=for-the-badge
+[license-shield]: https://img.shields.io/github/license/ClaperCo/Claper.svg?style=for-the-badge

guides/usage/authentication.md

@@ -0,0 +1,3 @@
+# Authentication
+
+Claper is passwordless, so you don't have to create an account. Just login with your email, check your mailbox ([localhost:4000/dev/mailbox](http://localhost:4000/dev/mailbox) if you have configured mail to be in local) and click on the link to get connected.

mix.exs

@@ -17,9 +17,27 @@ defmodule Claper.MixProject do
       source_url: "https://github.com/ClaperCo/Claper",
       homepage_url: "https://get.claper.co",
       docs: [
-        main: "Claper",
+        main: "overview",
+        assets: "guides/assets",
         logo: "priv/static/images/logo.png",
-        extras: ["guides/Configuration.md"]
+        extra_section: "GUIDES",
+        extras: [
+          "guides/introduction/overview.md",
+          "guides/introduction/configuration.md",
+          "guides/introduction/installation.md",
+
+          "guides/usage/authentication.md"
+        ],
+        groups_for_extras: [
+          Introduction: ~r/guides\/introduction\/.?/,
+          Guides: ~r/guides\/[^\/]+\.md/,
+          Usage: ~r/guides\/usage\/.?/
+        ],
+        groups_for_modules: [
+          Authentication: [
+            Claper.Accounts
+          ]
+        ]
       ]
     ]
   end