From fcb66d9b5ce1dd3fa09c880ce8f789720b4b3ad3 Mon Sep 17 00:00:00 2001 From: Hari Chalise Date: Tue, 17 Dec 2024 00:28:57 +0545 Subject: [PATCH] Refactor Docs [Remove Preview] (#7) Co-authored-by: aayush <177418358+aayushrg7@users.noreply.github.com> Co-authored-by: Smriti Bhandari <187972284+smritics@users.noreply.github.com> --- docs/.vitepress/config.ts | 82 +++++++++++++--------------- docs/acknowledgment/contributors.md | 2 +- docs/acknowledgment/inspiration.md | 2 +- docs/getting-started/introduction.md | 24 ++++++-- docs/getting-started/preview.md | 7 --- docs/github/codeofconduct.md | 1 + docs/github/roadmap.md | 1 + docs/index.md | 6 +- docs/installation/aur.md | 3 +- docs/installation/cli.md | 3 +- docs/installation/cmd.md | 1 + docs/installation/gtk.md | 3 + docs/scripts/scripts.md | 2 +- 13 files changed, 72 insertions(+), 65 deletions(-) delete mode 100644 docs/getting-started/preview.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 54c85b8..9a6d8e4 100644 --- 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 index 865ff60..8f3e6f4 100644 --- a/docs/acknowledgment/contributors.md +++ b/docs/acknowledgment/contributors.md @@ -1,4 +1,4 @@ - + **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 index e451e5f..7b96447 100644 --- 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 index d1a6212..df1191b 100644 --- a/docs/getting-started/introduction.md +++ b/docs/getting-started/introduction.md @@ -1,10 +1,20 @@ -# Introduction +

-## What is Carch? +carch „Snazzy“ + +**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 + + - **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? + + - **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 + + - **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 deleted file mode 100644 index 0f0fc5b..0000000 --- a/docs/getting-started/preview.md +++ /dev/null @@ -1,7 +0,0 @@ -# Carch Preview - -> [!Note] -> This preview is outdated. Several enhancements have been made since its release. To experience the latest version of Carch, consider installing it and exploring the updates. - -![Carch Preview](/carchv3.0.gif) - diff --git a/docs/github/codeofconduct.md b/docs/github/codeofconduct.md index bbddf90..c69530d 100644 --- a/docs/github/codeofconduct.md +++ b/docs/github/codeofconduct.md @@ -1,4 +1,5 @@ # Contributor Covenant Code of Conduct + ## Our Pledge diff --git a/docs/github/roadmap.md b/docs/github/roadmap.md index a04741e..a495d38 100644 --- a/docs/github/roadmap.md +++ b/docs/github/roadmap.md @@ -1,4 +1,5 @@ # Carch Project Roadmap + **Current Phase** *[ Advancing Script Development ]* diff --git a/docs/index.md b/docs/index.md index 324ba45..2bfab88 100644 --- 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: setup @@ -30,7 +30,7 @@ features: - icon: scripts title: Multiple Scripts details: Automate the setup of various environments, including Dwm and Hyprland. - - icon: development + - icon: 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 index 574bd1a..0812e58 100644 --- a/docs/installation/aur.md +++ b/docs/installation/aur.md @@ -1,4 +1,5 @@ -# Aur +# Aur [`Arch Linux`] + ![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 index d181958..ece1726 100644 --- a/docs/installation/cli.md +++ b/docs/installation/cli.md @@ -1,4 +1,5 @@ -# Installation +# Terminal + **To install Carch, execute the following command in your terminal:** diff --git a/docs/installation/cmd.md b/docs/installation/cmd.md index 917e23f..f006fc5 100644 --- a/docs/installation/cmd.md +++ b/docs/installation/cmd.md @@ -1,4 +1,5 @@ # CLI Commands + Carch now supports CLI commands! Use `carchcli` with the following options: diff --git a/docs/installation/gtk.md b/docs/installation/gtk.md index 80b0052..5b09f10 100644 --- a/docs/installation/gtk.md +++ b/docs/installation/gtk.md @@ -1,4 +1,5 @@ # GTK + **The GTK version of Carch is available.** @@ -26,6 +27,8 @@ carch-gtk ### From Source +
+ > [!NOTE] > *Before you start, you'll need to install `Python` dependencies.* diff --git a/docs/scripts/scripts.md b/docs/scripts/scripts.md index 2e95034..785c6b5 100644 --- a/docs/scripts/scripts.md +++ b/docs/scripts/scripts.md @@ -1,6 +1,6 @@ # Scripts - + **Carch comes with the following scripts to configure various aspects of your Arch-based system.**