Merge pull request #6 from dotkernel/intro

updated intro, installation
dotkernel · Nov 18, 2024 · 7cbd880 · 7cbd880
2 parents e74d312 + d2f9c4c
commit 7cbd880
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 6 deletions.
diff --git a/docs/book/v1/core-features/npm-commands.md → docs/book/v1/how-tos/npm-commands.md b/docs/book/v1/core-features/npm-commands.md → docs/book/v1/how-tos/npm-commands.md
diff --git a/docs/book/v1/installation/composer.md b/docs/book/v1/installation/composer.md
@@ -1,6 +1,6 @@
 # Composer Installation of Packages
 
-Composer is required to install Dotkernel `Light`. You can install Composer from the [official site](https://getcomposer.org/).
+Composer is required to install Dotkernel Light. You can install Composer from the [official site](https://getcomposer.org/).
 
 > First make sure that you have navigated your command prompt to the folder where you copied the files in the previous step.
 

diff --git a/docs/book/v1/installation/getting-started.md b/docs/book/v1/installation/getting-started.md
@@ -7,9 +7,29 @@
 > Read more on [dotkernel.com](https://www.dotkernel.com/php-development/almalinux-9-in-wsl2-install-php-apache-mariadb-composer-phpmyadmin/).
 
 Using your terminal, navigate inside the directory you want to download the project files into.
-Make sure that the directory is empty before proceeding to the download process.
+
+> Make sure that
+>
+> - The directory is empty before proceeding to the download process.
+>     - You will get this error if the directory is not empty `fatal: destination path '.' already exists and is not an empty directory.` and no files will be cloned.
+> - That you have writing permissions on the directory.
+
 Once there, run the following command:
 
 ```shell
 git clone https://github.com/dotkernel/light.git .
 ```
+
+If everything ran correctly, you can expect to see an output like this, though the numbers may differ.
+
+```shell
+Cloning into '.'...
+remote: Enumerating objects: 500, done.
+remote: Counting objects: 100% (500/500), done.
+remote: Compressing objects: 100% (435/435), done.
+remote: Total 500 (delta 51), reused 448 (delta 27), pack-reused 0 (from 0)
+Receiving objects: 100% (500/500), 399.14 KiB | 3.91 MiB/s, done.
+Resolving deltas: 100% (51/51), done.
+```
+
+You can already open the project in your preferred IDE to double-check the files were copied correctly.
diff --git a/docs/book/v1/introduction.md b/docs/book/v1/introduction.md
@@ -1,6 +1,15 @@
 # Dotkernel light
 
-Minimal project to generate a simple website.
+Dotkernel Light is an application (skeleton) using Mezzio microframework and Laminas components.
+It's designed as a minimal project to generate a simple website, like a presentation site.
+
+Read on to find out more about the application:
+
+- A technical **overview** to understand technical requirements and included packages
+- A step-by-step **installation** guide to get you up and running in minutes
+- Detailed **how-tos** for managing the dynamic content
+
+> Check out our [demo](https://light.dotkernel.net/).
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/light)
 ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/light/1.0.0)

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,9 +20,8 @@ nav:
           - "Development Mode": v1/installation/development-mode.md
           - "Running the Application": v1/installation/running-the-application.md
           - "FAQ": v1/installation/faq.md
-      - Core Features:
-          - "NPM Commands": v1/core-features/npm-commands.md
-      - How tos:
+      - How to:
+          - "Use NPM Commands": v1/core-features/npm-commands.md
           - "Create Pages": v1/how-tos/create-pages.md
           - "Set Up Twitter and OpenGraph Cards": v1/how-tos/twitter-opengraph-cards.md
           - "Edit the Top Menu": v1/how-tos/edit-top-menu.md