Skip to content

Commit f76820e

Browse files
authored
Spi support and docs fixes (#40)
* feat(docs): Create .spi.yml manifest * fix(docs): Update redirects to point to directory roots * docs: Add SPI documentation links and badges to README * Update README
1 parent 90491a6 commit f76820e

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

.github/workflows/docs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,22 +64,22 @@ jobs:
6464
6565
# 1. Root -> latest/documentation/fireblademath/
6666
create_redirect ".build/documentation/index.html" \
67-
"latest/documentation/fireblademath/index.html" \
67+
"latest/documentation/fireblademath/" \
6868
"Redirecting to Latest Docs"
6969
7070
# 2. latest/ -> main/documentation/fireblademath/
7171
create_redirect ".build/documentation/latest/index.html" \
72-
"../main/documentation/fireblademath/index.html" \
72+
"../main/documentation/fireblademath/" \
7373
"Redirecting to Main Docs"
7474
7575
# 3. latest/documentation/fireblademath/ -> main/documentation/fireblademath/
7676
create_redirect ".build/documentation/latest/documentation/fireblademath/index.html" \
77-
"../../../main/documentation/fireblademath/index.html" \
77+
"../../../main/documentation/fireblademath/" \
7878
"Redirecting to Main Docs"
7979
8080
# 4. documentation/fireblademath/ -> main/documentation/fireblademath/
8181
create_redirect ".build/documentation/documentation/fireblademath/index.html" \
82-
"../../main/documentation/fireblademath/index.html" \
82+
"../../main/documentation/fireblademath/" \
8383
"Redirecting to Main Docs"
8484
8585
- name: Check Documentation Quality

.spi.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version: 1
2+
external_links:
3+
documentation: "https://fireblade-engine.github.io/math/main/documentation/fireblademath/"

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[![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)
77
[![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)
88
[![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)
9+
[![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/)
910

1011
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).
1112

@@ -47,10 +48,18 @@ let package = Package(
4748
)
4849
```
4950

51+
For more detailed information and API reference, please refer to the [comprehensive documentation](https://fireblade-engine.github.io/math/main/documentation/fireblademath/).
52+
5053
### 🛠 SIMD Traits
5154

5255
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.
5356

57+
## 📖 Documentation
58+
59+
Comprehensive documentation for FirebladeMath is available online:
60+
61+
- [Documentation](https://fireblade-engine.github.io/math/main/documentation/fireblademath/)
62+
5463
## 📖 Usage Examples
5564

5665
### Vectors

0 commit comments

Comments
 (0)