From bde491b8fa2c1e21f2816e6e6a2bf5acddf6ecf1 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Wed, 11 Feb 2026 15:14:23 +0100 Subject: [PATCH 1/4] feat(docs): Create .spi.yml manifest --- .spi.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .spi.yml diff --git a/.spi.yml b/.spi.yml new file mode 100644 index 0000000..0f7d914 --- /dev/null +++ b/.spi.yml @@ -0,0 +1,3 @@ +version: 1 +external_links: + documentation: "https://fireblade-engine.github.io/math/main/documentation/fireblademath/" \ No newline at end of file From e85127f546303fe38b1b4d711d8a6d3a47ef34cc Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Wed, 11 Feb 2026 15:18:44 +0100 Subject: [PATCH 2/4] fix(docs): Update redirects to point to directory roots --- .github/workflows/docs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ba80709..c9bd9d8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -64,22 +64,22 @@ jobs: # 1. Root -> latest/documentation/fireblademath/ create_redirect ".build/documentation/index.html" \ - "latest/documentation/fireblademath/index.html" \ + "latest/documentation/fireblademath/" \ "Redirecting to Latest Docs" # 2. latest/ -> main/documentation/fireblademath/ create_redirect ".build/documentation/latest/index.html" \ - "../main/documentation/fireblademath/index.html" \ + "../main/documentation/fireblademath/" \ "Redirecting to Main Docs" # 3. latest/documentation/fireblademath/ -> main/documentation/fireblademath/ create_redirect ".build/documentation/latest/documentation/fireblademath/index.html" \ - "../../../main/documentation/fireblademath/index.html" \ + "../../../main/documentation/fireblademath/" \ "Redirecting to Main Docs" # 4. documentation/fireblademath/ -> main/documentation/fireblademath/ create_redirect ".build/documentation/documentation/fireblademath/index.html" \ - "../../main/documentation/fireblademath/index.html" \ + "../../main/documentation/fireblademath/" \ "Redirecting to Main Docs" - name: Check Documentation Quality From 523d89226af9eb8123b7d6483cba5e1676df2fc0 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Wed, 11 Feb 2026 15:19:25 +0100 Subject: [PATCH 3/4] docs: Add SPI documentation links and badges to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6064b21..6f93180 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Windows](https://github.com/fireblade-engine/math/actions/workflows/ci-windows.yml/badge.svg)](https://github.com/fireblade-engine/math/actions/workflows/ci-windows.yml) [![swift-version-compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/fireblade-engine/math) [![platform-compatilibilty](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/fireblade-engine/math) +[![Documentation](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Ddocumentation)](https://swiftpackageindex.com/fireblade-engine/math/documentation) A dependency-free, lightweight, fast math library for 2D and 3D vectors, quaternions, and matrices in Swift with (optional) SIMD support. It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine). @@ -47,10 +48,19 @@ let package = Package( ) ``` +For more detailed information and API reference, please refer to the [comprehensive documentation](https://swiftpackageindex.com/fireblade-engine/math/documentation). + ### 🛠 SIMD Traits Starting with version 1.0.0, FirebladeMath uses Swift traits to manage SIMD support. By default, SIMD is enabled on Apple platforms. You can manually control it in your package configuration if needed. +## 📖 Documentation + +Comprehensive documentation for FirebladeMath is available online: + +- [Latest Documentation on Swift Package Index](https://swiftpackageindex.com/fireblade-engine/math/documentation) +- [Main Branch Documentation on GitHub Pages](https://fireblade-engine.github.io/math/main/documentation/fireblademath/) + ## 📖 Usage Examples ### Vectors From 5fe6fbe91c0607d14d7ea44fe1293dd086c315e5 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Wed, 11 Feb 2026 15:29:03 +0100 Subject: [PATCH 4/4] Update README --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6f93180..853f097 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Windows](https://github.com/fireblade-engine/math/actions/workflows/ci-windows.yml/badge.svg)](https://github.com/fireblade-engine/math/actions/workflows/ci-windows.yml) [![swift-version-compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/fireblade-engine/math) [![platform-compatilibilty](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/fireblade-engine/math) -[![Documentation](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Ddocumentation)](https://swiftpackageindex.com/fireblade-engine/math/documentation) +[![Documentation](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Ddocumentation)](https://fireblade-engine.github.io/math/main/documentation/fireblademath/) A dependency-free, lightweight, fast math library for 2D and 3D vectors, quaternions, and matrices in Swift with (optional) SIMD support. It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine). @@ -48,7 +48,7 @@ let package = Package( ) ``` -For more detailed information and API reference, please refer to the [comprehensive documentation](https://swiftpackageindex.com/fireblade-engine/math/documentation). +For more detailed information and API reference, please refer to the [comprehensive documentation](https://fireblade-engine.github.io/math/main/documentation/fireblademath/). ### 🛠 SIMD Traits @@ -58,8 +58,7 @@ Starting with version 1.0.0, FirebladeMath uses Swift traits to manage SIMD supp Comprehensive documentation for FirebladeMath is available online: -- [Latest Documentation on Swift Package Index](https://swiftpackageindex.com/fireblade-engine/math/documentation) -- [Main Branch Documentation on GitHub Pages](https://fireblade-engine.github.io/math/main/documentation/fireblademath/) +- [Documentation](https://fireblade-engine.github.io/math/main/documentation/fireblademath/) ## 📖 Usage Examples