Refactor Docs [ Rework ] (#13)

Co-authored-by: aayush <[email protected]> Co-authored-by: Smriti Bhandari <[email protected]> Co-authored-by: aayushxvf <[email protected]>
carch-org · Feb 6, 2025 · 4404fe2 · 4404fe2
1 parent 62d5fac
commit 4404fe2
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 166 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -33,45 +33,16 @@ export default {
     ],
     sidebar: [
     { text: "Introduction", link: "/getting-started/introduction" },
-    {
-      text: "Installation",
-      collapsible: true,
-      collapsed: false,
-      items: [
-        { text: "Terminal", link: "/installation/cli" },
-        { text: "Commands", link: "/installation/cmd" },
-        { text: "TUI", link: "/installation/tui" },
-        { text: "PKG Build", link: "/installation/pkg" },
-        ],
-      },
-    {
-    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: "Installation", link: "/installation/cli" },
+    { text: "Commands", link: "/installation/cmd" },
+    { text: "TUI", link: "/installation/tui" },
+    { text: "Overview Scripts", link: "/scripts/scripts" },
+    { text: "Roadmap", link: "/github/roadmap" },
+    { text: "Contributing", link: "/github/contributing" },
+    { text: "Code of Conduct", link: "/github/codeofconduct" },
+    { text: "Inspiration", link: "/acknowledgment/inspiration" },
+    { text: "Contributions", link: "/acknowledgment/contributors" },
     ],
-  },
-],
     socialLinks: [
       { icon: "telegram", link: "https://t.me/carchx" },
       { icon: "discord", link: "https://discord.com/invite/8NJWstnUHd" },

diff --git a/docs/installation/cli.md b/docs/installation/cli.md
@@ -4,22 +4,28 @@
 **To install Carch, execute the following command in your terminal:**
 
 > [!INFO]
-> **Make sure to install `curl` before running this command** **`sudo pacman -S curl`**
+> **Make sure to install `curl` before running this command:** **`sudo pacman -S curl`** or **`sudo dnf install curl -y`**  
+>
+> **Also, check the `make` and `less` packages (for Arch only).**
 
 :::code-group
 
 
-```sh [Install]
-bash <(curl -L https://chalisehari.com.np/carchx)
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+bash <(curl -L https://chalisehari.com.np/arch)
 ```
 
-```sh [Run]
-carch
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+bash <(curl -L https://chalisehari.com.np/fedora)
 ```
 :::tip :bulb: TIP
 You don't need to run the installation script every time. You can run it once, and then simply type carch in your terminal whenever you want to automatically execute the Carch script.
 <br><br>
 If the installation command fails, you can try running
 <br>
-`curl -fsSL https://chalisehari.com.np/carchx | sh`
+`curl -fsSL https://chalisehari.com.np/arch | sh`
+
+or
+
+`curl -fsSL https://chalisehari.com.np/fedora | sh`
 :::
diff --git a/docs/installation/pkg.md b/docs/installation/pkg.md
diff --git a/docs/installation/tui.md b/docs/installation/tui.md
@@ -18,92 +18,9 @@ Keep in mind, the TUI is still in development, so bugs might pop up. If you find
 
 Lastly, a big thank you to [`ChrisTitusTech`](https://github.com/ChrisTitusTech) and the [`Contributors`](https://github.com/ChrisTitusTech/linutil/graphs/contributors). Your work in the Linux community is amazing, and I’m grateful to have been able to use your project as part of mine.  
 
+### Installation
 
-## Installation
-
-<img
-  src="https://cdn-icons-png.flaticon.com/128/733/733553.png"
-  alt="TUI"
-  width="50"
-  align="right"
- />
-
-### Install TUI Directly from the GitHub Repository 
-
-Run the following command to download and use the TUI directly:
-
-```sh 
-bash <(curl -L https://chalisehari.com.np/carchtui)
-```
-
-<br>
-
-<img
-  src="https://cdn-icons-png.flaticon.com/128/4555/4555440.png"
-  alt="TUI"
-  width="50"
-  align="right"
- />
-
-### Install Using the Main Script 
-
-This will download the TUI along with the main script. Once installed, you can run the TUI using:  
-- `carch --tui`  
-- `carch -t`
-
-First, install `carch` by running:  
-
-```sh
-bash <(curl -L https://chalisehari.com.np/carchx)
-```
-
-<br>
-
-<img 
-  src="https://cdn-icons-png.flaticon.com/128/487/487551.png"
-  alt="TUI"
-  width="45"
-  align="right"
- />
-
-###  Customize with `.toml` Files 
-
-The TUI supports custom `.toml` files for executing specific commands.  
-Here’s an example `carch.toml` configuration:
-
-```toml
-# example carch.toml
-
-auto_execute = [
-    "Communication Apps",
-    "Android",
-    "Thunar"
-]
-```
-
-<br>
-
-<img 
-  src="https://cdn-icons-png.flaticon.com/128/1753/1753543.png"
-  alt="TUI"
-  width="55"
-  align="right"
- />
-
-### **Usage**
-
-#### 🗂 Specify Your Configuration File  
-
-Save your `.toml` configuration file at:  
-`~/.config/carch/carch.toml` 
-
-To execute the commands in the order specified in your `.toml` file, run:  
-
-```sh
-carch-tui --config ~/.config/carch/carch.toml
-```
-
-This will execute the commands in the order you have specified in the `.toml` file.
+**To install, use the main script available [here](https://carch-org.github.io/docs/installation/cli.html).**
 
 > [!NOTE]
 > This TUI is an **optional feature** for a more user-friendly experience.