LLM-215 - enhance design

website/docs/01_introduction.md

@@ -3,23 +3,23 @@ slug: /
 ---
 # Introduction
 
-The eLLMental project raises from the necessity of developers to have a single framework that joins flexibility,
-efficiency, and productivity while building the different blocks of an AI application. During this time, we've seen different
+The ***eLLMental*** project raises from the necessity of developers to have a **single framework that joins flexibility,
+efficiency, and productivity** while building the different blocks of an **AI application**. During this time, we've seen different
 challenges that motivated us to start building this project:
 
-1. **Lack of Robust Tools and Libraries:** The field being fairly new means there's a lack of effective tools
+1. :hammer_and_wrench: **Lack of Robust Tools and Libraries:** The field being fairly new means there's a lack of effective tools
    custom-made for LLMs, making it more difficult for developers to understand how LLMs work nowadays.
-2. **MLOps management:** There's no one-size-fits-all solution in MLOps and particularly with LLMs, resulting in
+2. :brain: **MLOps management:** There's no one-size-fits-all solution in MLOps and particularly with LLMs, resulting in
    heterogeneity in the tools, platforms, and workflow processes. This means more time is needed to find the right
    stack. Also, evaluating LLMs' performance is not straightforward.
-3. **Security**: Ensuring the security of the underlying infrastructure, including network security, firewall
+3. :lock: **Security**: Ensuring the security of the underlying infrastructure, including network security, firewall
    configurations, and container security, is a major challenge. Setting up appropriate monitoring and alerts can be
    both technically challenging and resource-intensive.
-4. **Privacy:** LLMs often require large amounts of data, raising potential data privacy issues, which may not be
+4. :key: **Privacy:** LLMs often require large amounts of data, raising potential data privacy issues, which may not be
    adequately addressed by existing MLOps platforms.
-5. **Flexibility:** Regular applications need to grow constantly, and so do AI applications. That's why we are adopting a
+5. :jigsaw: **Flexibility:** Regular applications need to grow constantly, and so do AI applications. That's why we are adopting a
    flexible philosophy, by building separate software blocks that con compose themselves into bigger customizable AI
    applications.
 
-Overall, eLLMental is designed to help software engineers efficiently build AI-driven applications by
-removing all common headaches while integrating AI into your development environment.
+Overall, ***eLLMental*** is designed to help software engineers efficiently build AI-driven applications by
+**removing all common headaches while integrating AI into your development environment.**

website/docs/02_getting_started.md

@@ -8,7 +8,7 @@ map it to GraphQL or gRPC.
 > `ellmental-core` is built using Kotlin with JVM 17 and using gradle as our package manager.
 
 
-## Modules
+## :jigsaw: Modules
 
 The eLLMental project also implements three different AI modules:
 

website/docs/04_contributing.md

@@ -1,45 +1,45 @@
 # Contributing
 
 We're happy to see that you're interested in contributing, that's great! In the sections below, you can see how to report
-bugs or suggest enhancements.
+bugs or suggest enhancements :rocket:.
 
 
-## Reporting bugs
+## :bug: Reporting bugs
 
-Before creating a bug report, please search for similar issues to make sure that they're not already reported. If you
-don't find any, go ahead and create an issue including as many details as possible.
+Before creating a bug report, please **search for similar issues to make sure that they're not already reported. If you
+don't find any, go ahead and create an issue including as many details as possible.**
 
 > If you find a Closed issue that seems related to the issues that you're experiencing, make sure to reference it in the
 > body of your new one by writing its number like this => #42 (Github will auto-link it for you).
 
 Bugs are tracked as GitHub issues. Explain the problem and include additional details to help maintainers reproduce the
 problem:
 
-- Use a clear and descriptive title for the issue to identify the problem.
-- Describe the exact steps which reproduce the problem in as many details as possible.
-- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable
+- **Use a clear and descriptive title** for the issue to identify the problem.
+- **Describe the exact steps** which reproduce the problem in as many details as possible.
+- **Provide specific examples** to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable
   snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
-- Describe the behavior you observed after following the steps and point out what exactly is the problem with that
+- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that
   behavior.
-- Explain which behavior you expected to see instead and why.
-- If the problem is related to performance or memory, include a CPU profile capture with your report.
+- **Explain which behavior you expected to see** instead and why.
+- If the problem is related to performance or memory, **include a CPU profile capture with your report.**
 
-> Remember to label the issue with a "bug" tag
+> Remember to label the issue with a "**bug**" tag
 
-## Suggesting Enhancements
+## :bulb: Suggesting Enhancements
 
 Enhancement suggestions are tracked as GitHub issues. Make sure you provide the following information:
 
-- Use a clear and descriptive title for the issue to identify the suggestion.
-- Provide a step-by-step description of the suggested enhancement in as many details as possible.
-- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples,
+- **Use a clear and descriptive title** for the issue to identify the suggestion.
+- **Provide a step-by-step description** of the suggested enhancement in as many details as possible.
+- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples,
   as Markdown code blocks.
-- Describe the current behavior and explain which behavior you expected to see instead and why.
-- Explain why this enhancement would be useful to most Booster users and isn't something that can or should be
+- **Describe the current behavior** and explain which behavior you expected to see instead and why.
+- **Explain why this enhancement would be useful** to most eLLMental users and isn't something that can or should be
   implemented as a community package.
-- List some other libraries or frameworks where this enhancement exists.
+- **List some other libraries or frameworks where this enhancement exists.**
 
-> Remember to label the issue with an "enhancement" tag
+> Remember to label the issue with an "**enhancement**" tag
 
 # License
 

website/docusaurus.config.js

@@ -7,7 +7,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'eLLMental',
-  favicon: 'img/eLLMental logo with frame.png',
+  favicon: 'img/isotype.png',
 
   // Set the production url of your site here
   url: 'https://docs.ellmental.com',
@@ -59,10 +59,14 @@ const config = {
     ({
       // Replace with your project's social card
       image: 'img/eLLMental logo with frame.png',
+      stylesheets: [
+        "https://fonts.googleapis.com/css2?family=Poppins:wght@400;700&display=swap",
+      ],
       navbar: {
         logo: {
           alt: 'eLLMental Logo',
           src: '/img/eLLMental logo with frame.png',
+          srcDark: '/img/ellemental white.png'
         },
         items: [
           {

website/src/css/custom.css

@@ -6,7 +6,7 @@
 
 /* You can override the default Infima variables here. */
 :root {
-  --ifm-color-primary: #2e8555;
+  --ifm-color-primary: #5C00E2;
   --ifm-color-primary-dark: #29784c;
   --ifm-color-primary-darker: #277148;
   --ifm-color-primary-darkest: #205d3b;
@@ -15,16 +15,30 @@
   --ifm-color-primary-lightest: #3cad6e;
   --ifm-code-font-size: 95%;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+  --ifm-navbar-height: 5rem;
+  --ifm-font-family-base: 'Poppins', sans-serif;
+  --ifm-font-family-monospace: 'Poppins', sans-serif;
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */
 [data-theme='dark'] {
-  --ifm-color-primary: #25c2a0;
+  --ifm-color-primary: #BD94FA;
   --ifm-color-primary-dark: #21af90;
   --ifm-color-primary-darker: #1fa588;
   --ifm-color-primary-darkest: #1a8870;
   --ifm-color-primary-light: #29d5b0;
   --ifm-color-primary-lighter: #32d8b4;
   --ifm-color-primary-lightest: #4fddbf;
   --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+  --ifm-navbar-height: 5rem;
+  --ifm-font-family-base: 'Poppins', sans-serif;
+  --ifm-font-family-monospace: 'Poppins', sans-serif;
+}
+
+html[data-theme='light'] .navbar__logo {
+  height: 4.5rem;
+}
+
+html[data-theme='dark'] .navbar__logo {
+  height: 1rem;
 }