Doc updates (#107)

* Ignore all conductor files

* Update doc links

* Update SPI

* Update makefile

* Update docs for Swift 6.1

Author: ctreffs

.gitignore

@@ -55,3 +55,4 @@ timeline.xctimeline
 xcuserdata
 xcuserdata/Package.resolveddocs/
 conductor/tracks*
+conductor

.spi.yml

@@ -1,4 +1,3 @@
 version: 1
-builder:
-  configs:
-    - documentation_targets: [FirebladeECS]
+external_links:
+  documentation: "https://fireblade-engine.github.io/ecs"

CONTRIBUTING.md

@@ -83,7 +83,7 @@ Please consult the [README][ref-readme] for installation instructions.
 
 [ref-code-of-conduct]: https://github.com/fireblade-engine/ecs/blob/master/CODE_OF_CONDUCT.md
 [ref-contributors]: https://github.com/fireblade-engine/ecs/graphs/contributors
-[ref-documentation]: https://github.com/fireblade-engine/ecs/wiki
+[ref-documentation]: https://fireblade-engine.github.io/ecs
 [ref-gh-actions]: https://github.com/fireblade-engine/ecs/actions
 [ref-issues-first]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue"
 [ref-issues-help]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted"

Makefile

@@ -112,7 +112,7 @@ preview-analysis-docs:
 
 # Generates documentation pages suitable to push/host on github pages (or another static site)
 # Expected location, if set up, would be:
-#   https://fireblade-engine.github.io/FirebladeECS/documentation/FirebladeECS/
+#   https://fireblade-engine.github.io/ecs/ -> https://fireblade-engine.github.io/ecs/main/documentation/firebladeecs/
 generate-docs-githubpages:
 	DOCC_JSON_PRETTYPRINT=YES \
 	swift package \
@@ -122,7 +122,7 @@ generate-docs-githubpages:
 	--target FirebladeECS \
 	--output-path ./docs \
 	--transform-for-static-hosting \
-	--hosting-base-path 'FirebladeECS'
+	--hosting-base-path '$(REPO_NAME)'
 
 # --- Workflows ---
 

README.md

@@ -4,14 +4,14 @@
 [![Linux](https://github.com/fireblade-engine/ecs/actions/workflows/ci-linux.yml/badge.svg)](https://github.com/fireblade-engine/ecs/actions/workflows/ci-linux.yml)
 [![Windows](https://github.com/fireblade-engine/ecs/actions/workflows/ci-windows.yml/badge.svg)](https://github.com/fireblade-engine/ecs/actions/workflows/ci-windows.yml)
 [![WASM](https://github.com/fireblade-engine/ecs/actions/workflows/ci-wasm.yml/badge.svg)](https://github.com/fireblade-engine/ecs/actions/workflows/ci-wasm.yml)
-[![documentation](https://github.com/fireblade-engine/ecs/workflows/Documentation/badge.svg)](https://github.com/fireblade-engine/ecs/wiki)  
+[![documentation](https://github.com/fireblade-engine/ecs/workflows/Documentation/badge.svg)](https://fireblade-engine.github.io/ecs)  
 [![codecov](https://codecov.io/gh/fireblade-engine/ecs/branch/master/graph/badge.svg)](https://codecov.io/gh/fireblade-engine/ecs)
 [![spi-swift-versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fecs%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/fireblade-engine/ecs)
 [![spi-swift-platforms](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fecs%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/fireblade-engine/ecs)
 
 This is a **dependency free**, **lightweight**, **fast** and **easy to use** [Entity-Component System](https://en.wikipedia.org/wiki/Entity_component_system) implementation in Swift. It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine).
 
-See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) or have a look at [documentation in the wiki](https://github.com/fireblade-engine/ecs/wiki) to get started.
+See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) or have a look at [documentation](https://fireblade-engine.github.io/ecs) to get started.
 
 ## 🚀 Getting Started
 
@@ -25,19 +25,19 @@ These instructions will get you a copy of the project up and running on your loc
 
 ### 💻 Installing
 
-Fireblade ECS is available for all platforms that support [Swift 5.8](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
+Fireblade ECS is available for all platforms that support [Swift 6.1](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
 
 Extend the following lines in your `Package.swift` file or use it to create a new project.
 
 ```swift
-// swift-tools-version:5.8
+// swift-tools-version:6.1
 
 import PackageDescription
 
 let package = Package(
     name: "YourPackageName",
     dependencies: [
-        .package(url: "https://github.com/fireblade-engine/ecs.git", from: "0.17.5")
+        .package(url: "https://github.com/fireblade-engine/ecs.git", from: "0.17.7")
     ],
     targets: [
         .target(
@@ -233,7 +233,7 @@ See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) t
 
 ## 📖 Documentation
 
-Consult the [online documentation](https://swiftpackageindex.com/fireblade-engine/ecs/documentation/FirebladeECS), or preview it locally:
+Consult the [online documentation](https://fireblade-engine.github.io/ecs), or preview it locally:
 
 - `make preview-docs`
 

Sources/FirebladeECS/Documentation.docc/Documentation.md

@@ -7,7 +7,7 @@ Seamlessly, consistently, and asynchronously replicate data.
 This is a **dependency free**, **lightweight**, **fast** and **easy to use** [Entity-Component System](https://en.wikipedia.org/wiki/Entity_component_system) implementation in Swift. 
 An ECS comprises entities composed from components of data, with systems which operate on the components.
 
-Fireblade ECS is available for all platforms that support [Swift 5.8](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
+Fireblade ECS is available for all platforms that support [Swift 6.1](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
 It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine).
 
 For a more detailed example of FirebladeECS in action, see the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo).

Sources/FirebladeECS/Documentation.docc/GettingStartedWithFirebladeECS.md

@@ -10,14 +10,14 @@ An ECS comprises entities composed from components of data, with systems which o
 Extend the following lines in your `Package.swift` file or use it to create a new project.
 
 ```swift
-// swift-tools-version:5.8
+// swift-tools-version:6.1
 
 import PackageDescription
 
 let package = Package(
     name: "YourPackageName",
     dependencies: [
-        .package(url: "https://github.com/fireblade-engine/ecs.git", from: "0.17.5")
+        .package(url: "https://github.com/fireblade-engine/ecs.git", from: "0.17.7")
     ],
     targets: [
         .target(
@@ -33,7 +33,7 @@ For a more detailed example, see the [Fireblade ECS Demo App](https://github.com
 
 ### 🏛️ Nexus
 
-The core element in the Fireblade-ECS is the [Nexus](https://en.wiktionary.org/wiki/nexus#Noun). 
+The core element in the Fireblade ECS is the [Nexus](https://en.wiktionary.org/wiki/nexus#Noun). 
 It acts as a centralized way to store, access and manage entities and their components. 
 A single `Nexus` may (theoretically) hold up to 4294967295 `Entities` at a time.   
 You may use more than one `Nexus` at a time.