feat: add some assets and update intro

ccil-kbw · May 30, 2024 · 372a891 · 372a891
1 parent 232b1f4
commit 372a891
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,20 @@
 # ccil-kbw.github.io
+
 Documentation of the Droid developed for the Centre Khalid Ben Walid in Laval
+
+## MkDocs
+
+This documentation is built using [MkDocs](https://www.mkdocs.org/).
+
+### Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+### Development
+
+```bash
+mkdocs serve -
+```
+
diff --git a/docs/assets/header-0.png b/docs/assets/header-0.png
diff --git a/docs/assets/header-droid-0.png b/docs/assets/header-droid-0.png
diff --git a/docs/droid/intro.md b/docs/droid/intro.md
@@ -1,4 +1,35 @@
-
+<style>
+.md-content .md-typeset h1 { display: none; }
+</style>
+
+<p>
+    <img src="/assets/header-droid-0.png" alt="KBW Blueprint"/>
+</p>
+<p align="center">
+    <em>The Droid was born in the basement of KBW. It was developed to serve the Ummah.
+        <br><br>Feel free to Copy and Clone this Droid. Contributing back to the main project will be greatly appreciated but absolutely optional.
+        <br><br>Everything we do is for the sake of Allah only.
+    </em>
+</p>
+
+<p align="center">
+<a href="https://github.com/ccil-kbw/robot" target="_blank">
+    <img src="https://img.shields.io/github/last-commit/ccil-kbw/robot/master?style=flat-square" alt="Latest Commit">
+</a>
+<a href="https://github.com/ccil-kbw/robot/blob/master/LICENSE" target="_blank">
+    <img src="https://img.shields.io/github/license/ccil-kbw/robot" alt="Test">
+</a>
+<a href="https://github.com/ccil-kbw/robot/issues" target="_blank">
+    <img src="https://img.shields.io/github/issues/ccil-kbw/robot" alt="Coverage">
+</a>
+<a href="https://github.com/ccil-kbw/robot/actions" target="_blank">
+    <img src="https://github.com/ccil-kbw/robot/actions/workflows/publish.yml/badge.svg" alt="Package version">
+</a>
+</p>
+
+---
+
+_Features Documentation is outdated, please refer to the main repository for the latest documentation. We will do our best to update this._
 ## Masjid's Droid - Introduction
 
 The Masjid's Droid is the Application used at Khaled Ben Walid to serve the needs of the Administration. All features are Open to be used by anyone,

diff --git a/docs/index.md b/docs/index.md
@@ -1,9 +1,42 @@
-# Masjid's Droid Documentation
+<style>
+.md-content .md-typeset h1 { display: none; }
+</style>
 
-This page serves as a centralized place to document all tools developed by the Khaled Ben Walid team.
+<p>
+    <img src="./assets/header-0.png" alt="KBW Blueprint"/>
+</p>
+<p align="center">
+    <em>KBW Tech is dedicated to write the simplest solutions for the sake of Allah.</em>
+</p>
 
-For more information please visit [github organisation](https://github.com/ccil-kbw)
+<p align="center">
+<a href="https://github.com/ccil-kbw/robot" target="_blank">
+    <img src="https://img.shields.io/github/last-commit/ccil-kbw/robot/master?style=flat-square" alt="Latest Commit">
+</a>
+<a href="https://github.com/ccil-kbw/robot/blob/master/LICENSE" target="_blank">
+    <img src="https://img.shields.io/github/license/ccil-kbw/robot" alt="Test">
+</a>
+<a href="https://github.com/ccil-kbw/robot/issues" target="_blank">
+    <img src="https://img.shields.io/github/issues/ccil-kbw/robot" alt="Coverage">
+</a>
+<a href="https://github.com/ccil-kbw/robot/actions" target="_blank">
+    <img src="https://github.com/ccil-kbw/robot/actions/workflows/publish.yml/badge.svg" alt="Package version">
+</a>
+</p>
 
-Our IT organization does its best to keep all development as transparent as possible. Our main focus is the privacy and the security of our users. All code can be copied and used but can't be sold commercially.
+---
 
-Masjid's Droid was original written by [@serafdev](https://twitter.com/serafdev) to serve the needs of the beloved community of [Khaled Ben Walid](https://ccil-kbw.com) but is intended to benefit the whole beloved Ummah, East to West. Feel free to give us a star on GitHub, and leave us a comment there!
+**Documentation**: <a href="https://ccil-kbw.github.io" target="_blank">https://ccil-kbw.github.io</a>
+
+**Source Code**: <a href="https://github.com/ccil-kbw/robot" target="_blank">https://github.com/ccil-kbw/robot</a>
+
+---
+
+_**Qu'ran and Sunnah**_: We aim to make all our projects compliant with the Qu'ran and Sunnah.
+
+_**Simplicity**_: We aim to make all our projects easy to manage and maintain, even for non-technical users.
+
+_**Open Source**_: We aim to make all our projects open source to help other communities and developers.
+
+_**Community**_: We aim to make all our projects community-driven, so that the community can help us improve our
+projects.
diff --git a/docs/website_docs.md b/docs/website_docs.md
@@ -1,3 +1,5 @@
+_This is an outdated documentation of the Website, we have migrated to Wordpress, more to come._
+
 ## Introduction
 
 Our Masjid's Website is Open Source and is a Fork of the [Chirpy Jekyll theme](https://github.com/cotes2020/jekyll-theme-chirpy#readme), it is currently deployed on GitHub Pages to have free hosting, but overall it's simply a Frontend Static page so can be deployed anywhere.