Switch docs to Hextra theme

.github/workflows/publish.yml

@@ -29,10 +29,10 @@ jobs:
           go test -v ./docs/content/...
       - name: Run benchmark tables
         run: |
-          go run ./benchmark/table | tee docs/content/background/_benchmarks.md
+          go run ./benchmark/table | tee docs/content/generated/_benchmarks.md
       - name: Copy changelog
         run: |
-          cp ./CHANGELOG.md ./docs/content/background/_changelog.md
+          cp ./CHANGELOG.md ./docs/content/generated/_changelog.md
       - name: Setup Hugo
         uses: peaceiris/actions-hugo@v2
         with:

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 * Avoids heap allocations in generic `MapX` by using arrays for IDs (#478)
 
+### Documentation
+
+* Migrates the user guide to the [Hextra](https://imfing.github.io/hextra/) theme (#488)
+
 ## [[v0.15.2]](https://github.com/mlange-42/arche/compare/v0.15.1...v0.15.2)
 
 ### Performance

benchmark/table/components.go

@@ -10,19 +10,19 @@ import (
 
 func benchesComponents() []benchmark.Benchmark {
 	return []benchmark.Benchmark{
-		{Name: "World.Add 1 Comp", Desc: "memory already allocated", F: componentsAdd1_1000, N: 1000},
-		{Name: "World.Add 5 Comps", Desc: "memory already allocated", F: componentsAdd5_1000, N: 1000},
-		{Name: "World.Add 1 to 5 Comps", Desc: "memory already allocated", F: componentsAdd1to5_1000, N: 1000},
+		{Name: "World.Add 1 Comp", Desc: "memory already alloc.", F: componentsAdd1_1000, N: 1000},
+		{Name: "World.Add 5 Comps", Desc: "memory already alloc.", F: componentsAdd5_1000, N: 1000},
+		{Name: "World.Add 1 to 5 Comps", Desc: "memory already alloc.", F: componentsAdd1to5_1000, N: 1000},
 
-		{Name: "World.Remove 1 Comp", Desc: "memory already allocated", F: componentsRemove1_1000, N: 1000},
-		{Name: "World.Remove 5 Comps", Desc: "memory already allocated", F: componentsRemove5_1000, N: 1000},
-		{Name: "World.Remove 1 of 5 Comps", Desc: "memory already allocated", F: componentsRemove1of5_1000, N: 1000},
+		{Name: "World.Remove 1 Comp", Desc: "memory already alloc.", F: componentsRemove1_1000, N: 1000},
+		{Name: "World.Remove 5 Comps", Desc: "memory already alloc.", F: componentsRemove5_1000, N: 1000},
+		{Name: "World.Remove 1 of 5 Comps", Desc: "memory already alloc.", F: componentsRemove1of5_1000, N: 1000},
 
-		{Name: "World.Exchange 1 Comp", Desc: "memory already allocated", F: componentsExchange1_1000, N: 1000},
-		{Name: "World.Exchange 1 of 5 Comps", Desc: "memory already allocated", F: componentsExchange1of5_1000, N: 1000},
+		{Name: "World.Exchange 1 Comp", Desc: "memory already alloc.", F: componentsExchange1_1000, N: 1000},
+		{Name: "World.Exchange 1 of 5 Comps", Desc: "memory already alloc.", F: componentsExchange1of5_1000, N: 1000},
 
-		{Name: "Map1.Assign 1 Comps", Desc: "memory already allocated", F: componentsAssignGeneric1_1000, N: 1000},
-		{Name: "Map5.Assign 5 Comps", Desc: "memory already allocated", F: componentsAssignGeneric5_1000, N: 1000},
+		{Name: "Map1.Assign 1 Comps", Desc: "memory already alloc.", F: componentsAssignGeneric1_1000, N: 1000},
+		{Name: "Map5.Assign 5 Comps", Desc: "memory already alloc.", F: componentsAssignGeneric5_1000, N: 1000},
 	}
 }
 

benchmark/table/entities.go

@@ -12,16 +12,16 @@ func benchesEntities() []benchmark.Benchmark {
 	return []benchmark.Benchmark{
 		{Name: "Entity.IsZero", Desc: "", F: entitiesIsZero_2, N: 2},
 
-		{Name: "World.NewEntity", Desc: "memory already allocated", F: entitiesCreate_1000, N: 1000},
-		{Name: "World.NewEntity w/ 1 Comp", Desc: "memory already allocated", F: entitiesCreate_1Comp_1000, N: 1000},
-		{Name: "World.NewEntity w/ 5 Comps", Desc: "memory already allocated", F: entitiesCreate_5Comp_1000, N: 1000},
+		{Name: "World.NewEntity", Desc: "memory already alloc.", F: entitiesCreate_1000, N: 1000},
+		{Name: "World.NewEntity w/ 1 Comp", Desc: "memory already alloc.", F: entitiesCreate_1Comp_1000, N: 1000},
+		{Name: "World.NewEntity w/ 5 Comps", Desc: "memory already alloc.", F: entitiesCreate_5Comp_1000, N: 1000},
 
 		{Name: "World.RemoveEntity", Desc: "", F: entitiesRemove_1000, N: 1000},
 		{Name: "World.RemoveEntity w/ 1 Comp", Desc: "", F: entitiesRemove_1Comp_1000, N: 1000},
 		{Name: "World.RemoveEntity w/ 5 Comps", Desc: "", F: entitiesRemove_5Comp_1000, N: 1000},
 
-		{Name: "Map1.NewWith 1 Comp", Desc: "memory already allocated", F: entitiesCreateWithGeneric_1Comp_1000, N: 1000},
-		{Name: "Map5.NewWith 5 Comps", Desc: "memory already allocated", F: entitiesCreateWithGeneric_5Comp_1000, N: 1000},
+		{Name: "Map1.NewWith 1 Comp", Desc: "memory already alloc.", F: entitiesCreateWithGeneric_1Comp_1000, N: 1000},
+		{Name: "Map5.NewWith 5 Comps", Desc: "memory already alloc.", F: entitiesCreateWithGeneric_5Comp_1000, N: 1000},
 	}
 }
 

benchmark/table/main.go

@@ -30,4 +30,6 @@ func main() {
 	benchmark.RunBenchmarks("Components", benchesComponents(), benchmark.ToMarkdown)
 	benchmark.RunBenchmarks("Components, batched", benchesComponentsBatch(), benchmark.ToMarkdown)
 	benchmark.RunBenchmarks("Other", benchesOther(), benchmark.ToMarkdown)
+
+	fmt.Print("\n\n")
 }

benchmark/util.go

@@ -6,6 +6,7 @@ import (
 	"testing"
 )
 
+// Benchmark represents a benchmark to be run.
 type Benchmark struct {
 	Name   string
 	Desc   string
@@ -16,6 +17,7 @@ type Benchmark struct {
 	Units  string
 }
 
+// RunBenchmarks runs the benchmarks and prints the results.
 func RunBenchmarks(title string, benches []Benchmark, format func([]Benchmark) string) {
 	for i := range benches {
 		b := &benches[i]
@@ -25,6 +27,7 @@ func RunBenchmarks(title string, benches []Benchmark, format func([]Benchmark) s
 	fmt.Printf("## %s\n\n%s", title, format(benches))
 }
 
+// ToMarkdown converts the benchmarks to a markdown table.
 func ToMarkdown(benches []Benchmark) string {
 	b := strings.Builder{}