diff --git a/.github/mkdocs.yml b/.github/mkdocs.yml deleted file mode 100644 index 9f7e0038..00000000 --- a/.github/mkdocs.yml +++ /dev/null @@ -1,89 +0,0 @@ -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 diff --git a/docs/assets/preview.gif b/.github/preview.gif similarity index 100% rename from docs/assets/preview.gif rename to .github/preview.gif diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml deleted file mode 100644 index 94ca5e3c..00000000 --- a/.github/workflows/github-pages.yml +++ /dev/null @@ -1,56 +0,0 @@ -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 "\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 diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml index 4967eeef..07e2bd06 100644 --- a/.github/workflows/preview.yml +++ b/.github/workflows/preview.yml @@ -59,16 +59,16 @@ jobs: - name: Generate preview uses: charmbracelet/vhs-action@v2.1.0 with: - path: "docs/assets/preview.tape" + path: ".github/preview.tape" - name: Move preview - run: mv preview.gif docs/assets/preview.gif + run: mv preview.gif .github/preview.gif - name: Create PR uses: peter-evans/create-pull-request@v7.0.5 with: commit-message: Preview for ${{ env.tag_name }} - file-pattern: "docs/assets/preview.gif" + file-pattern: ".github/preview.gif" add-options: "--force" token: ${{ secrets.PAT_TOKEN }} branch: feature/preview-${{ env.tag_name }} diff --git a/.github/workflows/xtask.yml b/.github/workflows/xtask.yml deleted file mode 100644 index fab93937..00000000 --- a/.github/workflows/xtask.yml +++ /dev/null @@ -1,58 +0,0 @@ -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) diff --git a/README.md b/README.md index 78bd1d0e..867d16ce 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![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](docs/assets/preview.gif) +![Preview](/.github/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,13 +128,15 @@ 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://christitustech.github.io/linutil/). +For comprehensive information on how to use Linutil, visit the [Linutil Official Documentation](https://chris-titus-docs.github.io/linutil-docs/). ## ๐Ÿ›  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://christitustech.github.io/linutil/roadmap) +[Official LinUtil Roadmap](https://chris-titus-docs.github.io/linutil-docs/roadmap/) + +Docs are now [here](https://github.com/Chris-Titus-Docs/linutil-docs) ## ๐Ÿ… Thanks to All Contributors diff --git a/docs/KnownIssues.md b/docs/KnownIssues.md deleted file mode 100644 index 0d12097e..00000000 --- a/docs/KnownIssues.md +++ /dev/null @@ -1,4 +0,0 @@ -# Known Issues ---- - -- [Known Issues](https://github.com/ChrisTitusTech/linutil/issues) diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png deleted file mode 100644 index a4f4bc5d..00000000 Binary files a/docs/assets/favicon.png and /dev/null differ diff --git a/docs/assets/preview.tape b/docs/assets/preview.tape deleted file mode 100644 index 66b1c359..00000000 --- a/docs/assets/preview.tape +++ /dev/null @@ -1,89 +0,0 @@ -# VHS documentation -# -# Output: -# Output .gif Create a GIF output at the given -# Output .mp4 Create an MP4 output at the given -# Output .webm Create a WebM output at the given -# -# Require: -# Require Ensure a program is on the $PATH to proceed -# -# Settings: -# Set FontSize Set the font size of the terminal -# Set FontFamily Set the font family of the terminal -# Set Height Set the height of the terminal -# Set Width Set the width of the terminal -# Set LetterSpacing Set the font letter spacing (tracking) -# Set LineHeight Set the font line height -# Set LoopOffset % Set the starting frame offset for the GIF loop -# Set Theme Set the theme of the terminal -# Set Padding Set the padding of the terminal -# Set Framerate Set the framerate of the recording -# Set PlaybackSpeed Set the playback speed of the recording -# Set MarginFill Set the file or color the margin will be filled with. -# Set Margin Set the size of the margin. Has no effect if MarginFill isn't set. -# Set BorderRadius Set terminal border radius, in pixels. -# Set WindowBar Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight) -# Set WindowBarSize Set window bar size, in pixels. Default is 40. -# Set TypingSpeed