Refactor Docs [Remove Preview] (#7)

Co-authored-by: aayush <[email protected]> Co-authored-by: Smriti Bhandari <[email protected]>
carch-org · Dec 16, 2024 · fcb66d9 · fcb66d9
1 parent b56b6a1
commit fcb66d9
Show file tree

Hide file tree

Showing 13 changed files with 72 additions and 65 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -32,54 +32,46 @@ export default {
       },
     ],
     sidebar: [
-      {
-        text: "Getting Started",
-        collapsible: true,
-        collapsed: false,
-        items: [
-          { text: "Introduction", link: "/getting-started/introduction" },
-          { text: "Preview", link: "/getting-started/preview.md" },
-        ],
-      },
-      {
-        text: "Installation",
-        collapsible: true,
-        collapsed: false,
-        items: [
-          { text: "Terminal", link: "/installation/cli" },
-          { text: "Commands", link: "/installation/cmd" },
-          { text: "GTK", link: "/installation/gtk" },
-          { text: "Arch [AUR]", link: "/installation/aur" },
-        ],
-      },
-      {
-        text: "Utilities",
-        collapsible: true,
-        collapsed: false,
-        items: [
-          { text: "Overview Scripts", link: "/scripts/scripts" },
-        ],
-      },
-      {
-        text: "Collaboration",
-        collapsible: true,
-        collapsed: false,
-        items: [
-          { text: "Roadmap", link: "/github/roadmap" },
-          { text: "Contributing", link: "/github/contributing" },
-          { text: "Code of Conduct", link: "/github/codeofconduct" },
-        ],
-      },
-     {
-        text: "Acknowledgment",
-        collapsible: true,
-        collapsed: false,
-        items: [
-          { text: "Inspiration", link: "/acknowledgment/inspiration" },
-          { text: "Contributions", link: "/acknowledgment/contributors" },
+    { text: "Introduction", link: "/getting-started/introduction" },
+    {
+      text: "Installation",
+      collapsible: true,
+      collapsed: false,
+      items: [
+        { text: "Terminal", link: "/installation/cli" },
+        { text: "Commands", link: "/installation/cmd" },
+        { text: "GTK", link: "/installation/gtk" },
+        { text: "Arch [AUR]", link: "/installation/aur" },
         ],
       },
+    {
+    text: "Utilities",
+    collapsible: true,
+    collapsed: false,
+    items: [
+      { text: "Overview Scripts", link: "/scripts/scripts" },
+    ],
+  },
+  {
+    text: "Collaboration",
+    collapsible: true,
+    collapsed: false,
+    items: [
+      { text: "Roadmap", link: "/github/roadmap" },
+      { text: "Contributing", link: "/github/contributing" },
+      { text: "Code of Conduct", link: "/github/codeofconduct" },
+    ],
+  },
+  {
+    text: "Acknowledgment",
+    collapsible: true,
+    collapsed: false,
+    items: [
+      { text: "Inspiration", link: "/acknowledgment/inspiration" },
+      { text: "Contributions", link: "/acknowledgment/contributors" },
     ],
+  },
+],
     socialLinks: [
       { icon: "telegram", link: "https://t.me/harilvfs" },
       { icon: "discord", link: "https://discord.com/invite/8NJWstnUHd" },

diff --git a/docs/acknowledgment/contributors.md b/docs/acknowledgment/contributors.md
@@ -1,4 +1,4 @@
-<img src="https://cdn-icons-png.flaticon.com/128/4587/4587595.png" width="40" />
+<img src="https://cdn-icons-png.flaticon.com/128/4587/4587595.png" width="50" />
 
 **We thank everyone who has contributed to making `Carch` better. Your feedback and contributions are invaluable!**
 

diff --git a/docs/acknowledgment/inspiration.md b/docs/acknowledgment/inspiration.md
@@ -11,7 +11,7 @@
 
 One of my inspirations has been watching Chris Titus Tech's [live streams](https://www.youtube.com/@TitusTechTalk) and [videos](https://www.youtube.com/@ChrisTitusTech). Chris has been working on an amazing project called [`linutil`](https://github.com/ChrisTitusTech/linutil/). It gave me the idea to start building my own project, but in my own unique way. Initially, my project was quite basic—just a script with a `whiptail`-based TUI. It felt somewhat boring and clunky at the time.
 
-Later, I discovered another inspiring creator, ML4W (My Linux For Work), whose [Hyprland scripts and configurations](https://github.com/mylinuxforwork/dotfiles) are quite popular. After exploring their repository, I noticed he used tools like `gum` and `figlet` in their scripts. I was amazed to see how these tools added flair to bash scripting.
+Later, I discovered another inspiring creator, ML4W (My Linux For Work), whose [Hyprland scripts and configurations](https://github.com/mylinuxforwork/dotfiles) are quite popular. After exploring their repository, I noticed they used tools like `gum` and `figlet` in their scripts. I was amazed to see how these tools added flair to bash scripting.
 
 Inspired by this, I returned to my own scripting work and implemented `gum` and `figlet` for enhanced ASCII text and user interactivity. It wasn’t an instant success—the development process took time and effort—but day by day, my script became more polished. Now, I’m quite proud of what I’ve built, and I truly enjoy using these tools in my work.
 

diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md
@@ -1,10 +1,20 @@
-# Introduction
+<h1></h1>
 
-## What is Carch?   
+<img
+  src="/package.png"
+  alt="carch „Snazzy“"
+  width="25%"
+  align="right"
+ />
+
+**What is Carch?**
 
 **Carch** is a simple `Bash script` designed to simplify the process of setting up an `Arch` Linux system. With an intuitive menu interface powered by `gum`, Carch makes configuring your system as easy and efficient as possible, saving you valuable time.  
 
-## Features  
+
+## Features
+<img src="https://img.icons8.com/?size=80&id=vSx5PNyFqTTo&format=png" width="50" /> 
+
 - **Essential Package Installation**  
   *Install a variety of daily-use applications, such as file managers, browsers, text editors, and more.*  
 
@@ -23,14 +33,18 @@
 - **Window Manager Installation**  
   *Install and configure popular window managers like DWM, Hyprland, i3, and Sway, with more to come in future updates.*  
 
-## Why Choose Carch?  
+## Why Choose Carch?
+<img src="https://img.icons8.com/?size=80&id=111409&format=png" width="50" />
+
 - **Time-Saving**  
   *Carch’s preconfigured setups let you configure your system quickly and efficiently, without the hassle of manual installation and setup.*
 
 - **Stable and Reliable**  
   *Updates are only pushed after rigorous testing to ensure stability and a bug-free experience.*  
 
-## GTK and CLI Support  
+## GTK and CLI Support 
+<img src="https://img.icons8.com/?size=80&id=114423&format=png" width="50" />
+
 - **GTK Version**  
   *A GTK-based version of Carch is available `(currently in development)` for a more user-friendly, graphical experience.*  
 

diff --git a/docs/getting-started/preview.md b/docs/getting-started/preview.md
diff --git a/docs/github/codeofconduct.md b/docs/github/codeofconduct.md
@@ -1,4 +1,5 @@
 # Contributor Covenant Code of Conduct
+<img src="https://img.icons8.com/?size=80&id=X8FDBhUFMq9b&format=png" width="50" />
 
 ## Our Pledge
 

diff --git a/docs/github/roadmap.md b/docs/github/roadmap.md
@@ -1,4 +1,5 @@
 # Carch Project Roadmap 
+<img src="https://img.icons8.com/?size=80&id=CBfO8TrnezXC&format=png" width="50" />
 
 **Current Phase** *[ Advancing Script Development ]* <img src="https://cdn-icons-png.flaticon.com/128/4315/4315445.png" width="20" /> 
 

diff --git a/docs/index.md b/docs/index.md
@@ -15,10 +15,10 @@ hero:
       text: What is Carch? 
       link: /getting-started/introduction.md
     - theme: alt
-      text: Get Started
+      text: Install 
       link: /installation/cli.md
     - theme: alt
-      text: GitHub
+      text: GitHub ↗
       link: https://github.com/harilvfs/carch
 features:
   - icon: <img width="35" height="35" src="https://cdn-icons-png.flaticon.com/128/10229/10229090.png" alt="setup"/>
@@ -30,7 +30,7 @@ features:
   - icon: <img width="35" height="35" src="https://cdn-icons-png.flaticon.com/128/3131/3131638.png" alt="scripts"/>
     title: Multiple Scripts
     details: Automate the setup of various environments, including Dwm and Hyprland.
-  - icon: <img width="35" height="35" src="https://cdn-icons-png.flaticon.com/128/4205/4205106.png" alt="development"/>
+  - icon: <img width="35" height="35" src="https://cdn-icons-png.flaticon.com/128/3308/3308315.png" alt="development"/>
     title: Active Development
     details: Continuous updates and new features based on community feedback.
 ---

diff --git a/docs/installation/aur.md b/docs/installation/aur.md
@@ -1,4 +1,5 @@
-# Aur
+# Aur [`Arch Linux`]
+<img src="https://img.icons8.com/?size=48&id=uIXgLv5iSlLJ&format=png" width="50" />
 
 ![AUR Version](https://img.shields.io/aur/version/carch-git?style=for-the-badge&color=dbb6ed&logo=arch-linux&label=%5BAUR%5D%20carch-git&logocolor=85e185&labelColor=1c1c29)
 

diff --git a/docs/installation/cli.md b/docs/installation/cli.md
@@ -1,4 +1,5 @@
-# Installation
+# Terminal
+<img src="https://img.icons8.com/?size=80&id=v8LYQxpvZ4xX&format=png" width="60" />
 
 **To install Carch, execute the following command in your terminal:**
 

diff --git a/docs/installation/cmd.md b/docs/installation/cmd.md
@@ -1,4 +1,5 @@
 # CLI Commands  
+<img src="https://cdn-icons-png.flaticon.com/128/2581/2581117.png" width="40" />
 
 Carch now supports CLI commands! Use `carchcli` with the following options:  
 

diff --git a/docs/installation/gtk.md b/docs/installation/gtk.md
@@ -1,4 +1,5 @@
 # GTK
+<img src="https://cdn-icons-png.flaticon.com/128/9521/9521756.png" width="50" />
 
 **The GTK version of Carch is available.**
 
@@ -26,6 +27,8 @@ carch-gtk
 
 
 ### From Source
+<br>
+<img src="https://cdn-icons-png.flaticon.com/128/14849/14849647.png" width="30" />
 
 > [!NOTE]
 > *Before you start, you'll need to install `Python` dependencies.*

diff --git a/docs/scripts/scripts.md b/docs/scripts/scripts.md
@@ -1,6 +1,6 @@
 # Scripts
 
-<img src="https://cdn-icons-png.flaticon.com/128/3721/3721643.png" width="30" />
+<img src="https://cdn-icons-png.flaticon.com/128/3721/3721643.png" width="40" />
 
 **Carch comes with the following scripts to configure various aspects of your Arch-based system.**