Rename and refactor crate

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          components: rustfmt, clippy
+          cache: false
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-
+
+      - name: Install mdBook
+        run: cargo install --locked mdbook --version 0.5.3
+
+      - name: Run CI checks
+        run: bin/check --allow-dirty --no-gpu

.github/workflows/docs.yml

@@ -0,0 +1,64 @@
+name: Deploy Book
+
+on:
+  push:
+    branches:
+      - main
+      - vk-graph
+    paths-ignore:
+      - "bin/**"
+      - "examples/**"
+
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          cache: false
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-
+
+      - name: Install mdBook
+        run: cargo install --locked mdbook --version 0.5.3
+
+      - name: Build Book
+        run: |
+          cd guide
+          mdbook build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: guide/book
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/gpu.yml

@@ -0,0 +1,46 @@
+name: GPU
+
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: gpu-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  gpu:
+    name: GPU smoke and full checks
+    runs-on: [self-hosted, linux, vulkan]
+    timeout-minutes: 45
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          components: rustfmt, clippy
+          cache: false
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-
+
+      - name: Install mdBook
+        run: cargo install --locked mdbook --version 0.5.3
+
+      - name: Run full checks with GPU
+        run: bin/check --allow-dirty

.github/workflows/rust-clippy.yml

@@ -1,54 +1,66 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# rust-clippy is a tool that runs a bunch of lints to catch common
-# mistakes in your Rust code and help improve your Rust code.
-# More details at https://github.com/rust-lang/rust-clippy 
-# and https://rust-lang.github.io/rust-clippy/
-
-name: rust-clippy analyze
+name: Clippy SARIF
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [ main ]
   schedule:
     - cron: '24 22 * * 3'
 
+concurrency:
+  group: clippy-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   rust-clippy-analyze:
     name: Run rust-clippy analyzing
     runs-on: ubuntu-latest
+    timeout-minutes: 30
     permissions:
       contents: read
       security-events: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install Rust toolchain
-        uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af #@v1
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          profile: minimal
           toolchain: stable
           components: clippy
-          override: true
+          cache: false
+
+      - name: Restore Rust cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-
 
       - name: Install required cargo
-        run: cargo install clippy-sarif sarif-fmt
+        run: |
+          cargo install --locked clippy-sarif --version 0.8.0
+          cargo install --locked sarif-fmt --version 0.8.0
 
       - name: Run rust-clippy
-        run:
-          cargo clippy
-          --all-features
-          --message-format=json | clippy-sarif | tee rust-clippy-results.sarif | sarif-fmt
-        continue-on-error: true
+        shell: bash
+        run: |
+          set -o pipefail
+          cargo clippy --all-targets --workspace --no-default-features --features loaded --message-format=json \
+            | clippy-sarif \
+            | tee rust-clippy-results.sarif \
+            | sarif-fmt
 
       - name: Upload analysis results to GitHub
-        uses: github/codeql-action/upload-sarif@v1
+        if: always()
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: rust-clippy-results.sarif
           wait-for-processing: true

.gitignore

@@ -1,7 +1,8 @@
 Cargo.lock
 **/target/
 **/.vscode/
-!contrib/.vscode/
 imgui.ini
+libdxcompiler.so
 **/*.pak
-**/*.profraw
+**/*.profraw
+AGENTS.md

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Screen 13
+# Contributing to vk-graph
 
 Thank you for taking the time to look over this document. You are encouraged to open issues, submit
 PRs, suggest changes, or anything else you feel might move this project forward.
@@ -12,7 +12,7 @@ This section lists the absolute minimum requirements you must understand and pra
 involved with this project. If you fail to uphold the spirit of these rules you will not have any
 access to make changes within this project and you may be banned entirely.
 
-## Licesnsing Requirements
+## Licensing Requirements
 
 All contributions, ideas, issues, or other efforts you expend on this project must be provided
 using the existing MIT or Apache 2.0 license agreements applied to this project. This means that
@@ -24,12 +24,12 @@ retain no ownership or control after contribution.
 
 All code must:
 
-- Be modern Rust code (currently 2021 edition, latest stable compiler) _or_ GLSL.
+- Be modern Rust code (currently 2024 edition, latest stable compiler) _or_ GLSL.
 - Pass `cargo fmt` and `cargo clippy` (debug and release) with no warnings
 - Support required platforms: Linux, Mac, Windows
 - Use only `crates.io`-published crates
 
-### Recommentations
+### Recommendations
 
 All code should:
 
@@ -54,8 +54,8 @@ needed.
 ## Release checklist
 
 - Run `cargo update` to ensure you have the latest dependencies
-- Double-check `cargo clippy --release` and `cargo fmt` _(use `contrib/rel-mgmt/check`)_
-- Double-check all examples compile and run as intended _(use `contrib/rel-mgmt/run-all-examples`)_
+- Double-check `cargo clippy --release` and `cargo fmt` _(use `bin/check`)_
+- Double-check all examples compile and run as intended _(use `bin/run-all-examples`)_
 - Double-check the above on all supported platforms
 - Change log: Add a section for the new version
 - Change log: Transfer unreleased details to the new version