Merge f2b1edf2eb into 8639da3855

.github/mkdocs.yml

@@ -0,0 +1,89 @@
+site_name: Chris Titus LinUtil Official Documentation
+repo_url: https://github.com/ChrisTitusTech/linutil
+docs_dir: '../docs'
+
+nav:
+  - Introduction: 'index.md'
+  - User Guide: 'userguide.md'
+  - Contributing:
+      - Contributing Guide: 'contributing.md'
+      - Roadmap: 'roadmap.md'
+  - Documentation:
+      - Known Issues: 'KnownIssues.md'
+  - FAQ: 'faq.md'
+
+theme:
+  name: material
+  custom_dir: '../overrides'
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotation
+    - content.code.copy
+  language: en
+  logo: assets/favicon.png
+  favicon: assets/favicon.png
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      accent: blue
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      accent: blue
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - abbr
+  - attr_list
+  - pymdownx.snippets
+  - md_in_html
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - def_list
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - toc:
+      permalink: true
+
+plugins:
+  - search
+  - awesome-pages
+  - git-revision-date-localized
+  - minify:
+      minify_html: true
+      htmlmin_opts:
+          remove_comments: true
+      cache_safe: true

.github/workflows/github-pages.yml

@@ -0,0 +1,56 @@
+name: GitHub Pages Deploy
+
+on:
+  push:
+    paths:
+      - '.github/mkdocs.yml'
+      - '.github/requirements.txt'
+      - 'docs/**'
+      - 'overrides/**'
+      - '.github/CONTRIBUTING.md'
+  workflow_dispatch:
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    environment: linutil_env
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'  # Fetch all commit history for all branches as well as tags.
+
+      - name: Copy Contributing Guidelines
+        run: |
+          echo -e "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: Update Contributing Guidelines
+          title: 'docs: Update Contributing Guidelines'
+          body: 'Automated update of Contributing Guidelines from .github/CONTRIBUTING.md'
+          branch: update-contributing-guidelines
+          delete-branch: true
+          base: main
+          labels: documentation
+          token: ${{ secrets.PAT_TOKEN }}
+        if: success()
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x  # Install latest Stable release of Python 3
+          cache: 'pip'  # Caching pip dependencies
+
+      - name: Install Necessary Dependencies
+        run: pip install -r .github/requirements.txt
+
+      - name: Build & Deploy using mkdocs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: mkdocs gh-deploy --force -f .github/mkdocs.yml

.github/workflows/preview.yml

@@ -59,16 +59,16 @@ jobs:
       - name: Generate preview
         uses: charmbracelet/vhs-action@v2.1.0
         with:
-          path: ".github/preview.tape"
+          path: "docs/assets/preview.tape"
 
       - name: Move preview
-        run: mv preview.gif .github/preview.gif
+        run: mv preview.gif docs/assets/preview.gif
 
       - name: Create PR
         uses: peter-evans/create-pull-request@v7.0.5
         with:
           commit-message: Preview for ${{ env.tag_name }}
-          file-pattern: ".github/preview.gif"
+          file-pattern: "docs/assets/preview.gif"
           add-options: "--force"
           token: ${{ secrets.PAT_TOKEN }}
           branch: feature/preview-${{ env.tag_name }}

.github/workflows/xtask.yml

@@ -0,0 +1,58 @@
+name: XTasks
+
+on:
+  pull_request:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
+  push:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  docgen:
+    name: DocGen
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-registry-
+
+      - name: Cache Cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-index-
+
+      - name: Run cargo xtask docgen
+        run: cargo xtask docgen
+
+      - name: Check uncommitted documentation changes
+        run: |
+          git diff
+          git diff-files --quiet \
+            || (echo "Run 'cargo xtask docgen' and push the changes" \
+            && exit 1)

README.md

@@ -7,7 +7,7 @@
 <!-- TODO: crates.io package here + <br> -->
 [![Crates.io Version](https://img.shields.io/crates/v/linutil_tui?style=for-the-badge&color=%23af3a03)](https://crates.io/crates/linutil_tui) [![linutil AUR Version](https://img.shields.io/aur/version/linutil?style=for-the-badge&label=%5BAUR%5D%20linutil&color=%23230567ff)](https://aur.archlinux.org/packages/linutil) [![linutil-bin AUR Version](https://img.shields.io/aur/version/linutil-bin?style=for-the-badge&label=%5BAUR%5D%20linutil-bin&color=%23230567ff)](https://aur.archlinux.org/packages/linutil-bin)
 
-![Preview](/.github/preview.gif)
+![Preview](docs/assets/preview.gif)
 
 **Linutil** is a distro-agnostic toolbox designed to simplify everyday Linux tasks. It helps you set up applications and optimize your system for specific use cases. The utility is actively developed in Rust 🦀, providing performance and reliability.
 
@@ -128,15 +128,13 @@ If you find Linutil helpful, please consider giving it a ⭐️ to show your sup
 
 ## 🎓 Documentation
 
-For comprehensive information on how to use Linutil, visit the [Linutil Official Documentation](https://chris-titus-docs.github.io/linutil-docs/).
+For comprehensive information on how to use Linutil, visit the [Linutil Official Documentation](https://christitustech.github.io/linutil/).
 
 ## 🛠 Contributing
 
 We welcome contributions from the community! Before you start, please review our [Contributing Guidelines](.github/CONTRIBUTING.md) to understand how to make the most effective and efficient contributions.
 
-[Official LinUtil Roadmap](https://chris-titus-docs.github.io/linutil-docs/roadmap/)
+[Official LinUtil Roadmap](https://christitustech.github.io/linutil/roadmap)
-
-Docs are now [here](https://github.com/Chris-Titus-Docs/linutil-docs)
 
 ## 🏅 Thanks to All Contributors
 

docs/KnownIssues.md

@@ -0,0 +1,4 @@
+# Known Issues
+---
+
+- [Known Issues](https://github.com/ChrisTitusTech/linutil/issues)

docs/assets/preview.tape

@@ -0,0 +1,89 @@
+# VHS documentation
+#
+# Output:
+#   Output <path>.gif               Create a GIF output at the given <path>
+#   Output <path>.mp4               Create an MP4 output at the given <path>
+#   Output <path>.webm              Create a WebM output at the given <path>
+#
+# Require:
+#   Require <string>                Ensure a program is on the $PATH to proceed
+#
+# Settings:
+#   Set FontSize <number>           Set the font size of the terminal
+#   Set FontFamily <string>         Set the font family of the terminal
+#   Set Height <number>             Set the height of the terminal
+#   Set Width <number>              Set the width of the terminal
+#   Set LetterSpacing <float>       Set the font letter spacing (tracking)
+#   Set LineHeight <float>          Set the font line height
+#   Set LoopOffset <float>%         Set the starting frame offset for the GIF loop
+#   Set Theme <json|string>         Set the theme of the terminal
+#   Set Padding <number>            Set the padding of the terminal
+#   Set Framerate <number>          Set the framerate of the recording
+#   Set PlaybackSpeed <float>       Set the playback speed of the recording
+#   Set MarginFill <file|#000000>   Set the file or color the margin will be filled with.
+#   Set Margin <number>             Set the size of the margin. Has no effect if MarginFill isn't set.
+#   Set BorderRadius <number>       Set terminal border radius, in pixels.
+#   Set WindowBar <string>          Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight)
+#   Set WindowBarSize <number>      Set window bar size, in pixels. Default is 40.
+#   Set TypingSpeed <time>          Set the typing speed of the terminal. Default is 50ms.
+#
+# Sleep:
+#   Sleep <time>                    Sleep for a set amount of <time> in seconds
+#
+# Type:
+#   Type[@<time>] "<characters>"    Type <characters> into the terminal with a
+#                                   <time> delay between each character
+#
+# Keys:
+#   Escape[@<time>] [number]        Press the Escape key
+#   Backspace[@<time>] [number]     Press the Backspace key
+#   Delete[@<time>] [number]        Press the Delete key
+#   Insert[@<time>] [number]        Press the Insert key
+#   Down[@<time>] [number]          Press the Down key
+#   Enter[@<time>] [number]         Press the Enter key
+#   Space[@<time>] [number]         Press the Space key
+#   Tab[@<time>] [number]           Press the Tab key
+#   Left[@<time>] [number]          Press the Left Arrow key
+#   Right[@<time>] [number]         Press the Right Arrow key
+#   Up[@<time>] [number]            Press the Up Arrow key
+#   Down[@<time>] [number]          Press the Down Arrow key
+#   PageUp[@<time>] [number]        Press the Page Up key
+#   PageDown[@<time>] [number]      Press the Page Down key
+#   Ctrl+<key>                      Press the Control key + <key> (e.g. Ctrl+C)
+#
+# Display:
+#   Hide                            Hide the subsequent commands from the output
+#   Show                            Show the subsequent commands in the output
+
+Output preview.gif
+
+Require linutil
+Require sh
+
+Set Shell "bash"
+Set FontFamily "JetBrainsMono Nerd Font"
+Set FontSize 24
+Set Width 1920
+Set Height 1080
+
+Sleep 1s
+
+Type "linutil" Sleep 1s  Enter
+
+Sleep 5s
+
+Left Sleep 2s
+Down Sleep 1s
+Down Sleep 1s
+Down Sleep 1s
+Down Sleep 2s
+Right Sleep 3s
+
+Type "/" Sleep 1s
+Type@200ms "System Cleanup" Sleep 1s  Enter
+
+Sleep 2s
+Enter Sleep 3s
+Type "y" Sleep 15s    # CONFIRMATION PROMPT
+
+Escape

docs/contributing.md

@@ -0,0 +1,72 @@
+<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->
+
+# Contributing Guidelines for Linutil
+
+Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:
+
+## 1. **Install Rust**: 
+
+Make sure you have Rust installed on your machine. You can install it by following the instructions at [rust-lang.org](https://www.rust-lang.org/tools/install).
+
+## 2. **Fork and Clone the repo**
+
+1. Make a fork of the repo in GitHub
+2. Clone the fork
+```bash
+git clone https://github.com/YOUR_USERNAME_HERE/linutil.git
+cd linutil
+   ```
+
+## 3. Make your changes
+
+- **Edit the files you want to change**: Make your changes to the relevant files.
+- **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected.
+
+## 4. Understand the existing code
+
+- **Have a clear reason**: Don’t change the way things are done without a valid reason. If you propose an alteration, be prepared to explain why it’s necessary and how it improves the project.
+- **Respect existing conventions**: Changes should align with the existing code style, design patterns, and overall project philosophy. If you want to introduce a new way of doing things, justify it clearly.
+
+## 5. Learn from Past Pull Requests (PRs)
+
+- **Check merged PRs**: Reviewing merged pull requests can give you an idea of what kind of contributions are accepted and how they are implemented.
+- **Study rejected PRs**: This is especially important as it helps you avoid making similar mistakes or proposing changes that have already been considered and declined.
+
+## 6. Write Clean, Descriptive Commit Messages
+
+- **Be descriptive**: Your commit messages should clearly describe what the change does and why it was made.
+- **Use the imperative mood**: For example, "Add feature X" or "Fix bug in Y", rather than "Added feature X" or "Fixed bug in Y".
+- **Keep commits clean**: Avoid committing a change and then immediately following it with a fix for that change. Instead, amend your commit or squash it if needed.
+
+## 7. Keep Your Pull Requests (PRs) Small and Focused
+
+- **Make small, targeted PRs**: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance.
+- **Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.
+
+## 8. Understand and Test the Code You Write
+
+- **Review your code**: Before submitting your changes, take the time to review your code for readability, efficiency and performance. Consider how your changes affect the project.
+- **Avoid using LLMs**: Don't submit AI-generated code without reviewing and testing it first. Ensure that any code you submit is thoroughly understood and meets the project's standards.
+- **Testing Requirements**: Failure to conduct testing after multiple requests may result in the closure of your Pull Request.
+
+## 9. Code Review and Feedback
+
+- **Expect feedback**: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
+- **Participate in reviews**: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions.
+
+## 10. Contributing Is More Than Just Code
+
+- **Test the tool**: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
+- **Write well-formed issues**: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
+- **Propose reasonable feature requests**: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases.
+
+## 11. Documentation
+
+- **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.
+- **Automatic generation**: If you decide to add functionality through a new shell script, make sure to fill out all fields in `tab_data.toml` and run `cargo xtask docgen`.
+
+## 12. License
+
+- **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.
+
+We appreciate your contributions and look forward to collaborating with you to make Linutil better!

docs/faq.md

@@ -0,0 +1,4 @@
+# FAQ's
+
+## How do I uninstall LinUtil?
+* You do not have to uninstall LinUtil. As it is a script you run from your terminal it only loads into your RAM. This means as soon as you close LinUtil it will be deleted off your system.

docs/index.md

@@ -0,0 +1,76 @@
+# Welcome to the LinUtil Documentation!
+
+[![Version](https://img.shields.io/github/v/release/ChrisTitusTech/linutil?color=%230567ff&label=Latest%20Release&style=for-the-badge)](https://github.com/ChrisTitusTech/linutil/releases/latest)
+![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/linutil?label=Total%20Downloads&style=for-the-badge)
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/bujFYKAHSp)](https://discord.gg/bujFYKAHSp)
+
+[![Crates.io Version](https://img.shields.io/crates/v/linutil_tui?style=for-the-badge&color=%23af3a03)](https://crates.io/crates/linutil_tui) [![linutil AUR Version](https://img.shields.io/aur/version/linutil?style=for-the-badge&label=%5BAUR%5D%20linutil&color=%23230567ff)](https://aur.archlinux.org/packages/linutil) [![linutil-bin AUR Version](https://img.shields.io/aur/version/linutil-bin?style=for-the-badge&label=%5BAUR%5D%20linutil-bin&color=%23230567ff)](https://aur.archlinux.org/packages/linutil-bin)
+
+## Running the latest release of LinUtil
+
+To get started, run the following command in your terminal:
+
+### Stable branch
+
+```
+curl -fsSL https://christitus.com/linux | sh
+```
+---
+
+### Installation
+
+LinUtil is also available as a package in various repositories:
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/linutil.svg)](https://repology.org/project/linutil/versions)
+
+<details>
+  <summary>Arch Linux</summary>
+
+LinUtil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages:
+
+- `linutil` - Stable release compiled from source
+- `linutil-bin` - Stable release pre-compiled
+- `linutil-git` - Compiled from the last commit (not recommended)
+
+by running:
+
+```bash
+git clone https://aur.archlinux.org/<package>.git
+cd linutil
+makepkg -si
+```
+
+Replace `<package>` with your preferred package.
+
+If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler:
+
+```bash
+paru -S linutil
+```
+
+Replace `paru` with your preferred helper and `linutil` with your preferred package.
+
+</details>
+
+<details>
+  <summary>Cargo</summary>
+
+LinUtil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with:
+
+```bash
+cargo install linutil
+```
+
+Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup))
+
+</details>
+
+---
+
+After you've ran the command, you should see a GUI on your screen; It will look something like this:
+
+![preview](assets/preview.gif)
+
+!!! info
+
+    LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

docs/roadmap.md

@@ -25,4 +25,3 @@
 
 ## Community Feedback
 - Encourage community input and suggestions for future development.
-

docs/userguide.md

@@ -140,4 +140,3 @@ https://github.com/ChrisTitusTech/dwm-titus
 - **Ollama**: This utility is designed to manage ollama in your system
 - **Service Manager**: This utility is designed to manage services in your system
 - **WiFi Manager**: This utility is designed to manage wifi in your system
-

overrides/main.html

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+
+{% block header %}
+    {{ super() }}
+    <div style="color: red; text-align: center; padding: 10px; font-size: 20px;">
+        <strong>Announcement:</strong> This documentation is still in progress.
+    </div>
+{% endblock %}
+
+{% block footer %}
+    {# Empty block to override the footer #}
+{% endblock %}