docs: improve release and test documentation (#9609)

- Reorder the release-related documents into one heading.
 - Added CocoaPods README as part of the documentation.
 - Fixed typo for renderdiff doc
 - Added backend test doc

docs_src/build/duplicates.json

@@ -49,6 +49,9 @@
     "libs/fgviewer/README.md": {
         "dest": "dup/fgviewer.md"
     },
+    "ios/CocoaPods/README.md": {
+        "dest": "release/cocoapods.md"
+    },
     "tools/normal-blending/README.md": {
         "dest": "dup/normal_blending.md"
     },
@@ -83,9 +86,12 @@
         "dest": "dup/docs.md"
     },
     "test/renderdiff/README.md": {
-        "dest": "dup/renderdiff.md",
+        "dest": "dup/test_renderdiff.md",
         "link_transforms": {
             "docs/images/": "../images/"
         }
+    },
+    "test/backend/README.md": {
+        "dest": "dup/test_backend.md"
     }
 }

docs_src/src_mdbook/src/SUMMARY.md

@@ -2,8 +2,7 @@
 
 - [Introduction](./dup/intro.md)
   - [Build](./dup/building.md)
-    - [Build for Android on Windows](./build/windows_android.md)
+    - [Android on Windows](./build/windows_android.md)
-    - [Maven Release](./build/maven_release.md)
   - [Contribute](./dup/contributing.md)
   - [Coding Style](./dup/code_style.md)
 - [Core Concepts](./main/README.md)
@@ -14,9 +13,12 @@
   - [Web Tutorial](./samples/web.md)
 - [Technical Notes](./notes/README.md)
   - [Material Properties](./notes/material_properties.md)
-  - [Versioning](./notes/versioning.md)
+  - [Release](./release/README.md)
-    - [Branching](./notes/branching.md)
+    - [CocoaPods](./release/cocoapods.md)
-    - [Release Guide](./notes/release_guide.md)
+    - [Maven](./release/maven.md)
+    - [Github](./release/guide.md)
+    - [Versioning](./release/versioning.md)
+    - [Branching](./release/branching.md)
   - [Documentation](./dup/docs.md)
   - [Debugging](./notes/debugging.md)
     - [Metal](./notes/metal_debugging.md)
@@ -28,7 +30,8 @@
     - [Performance analysis](./notes/performance_analysis.md)
   - [Framegraph](./notes/framegraph.md)
   - [Tests](./notes/tests.md)
-    - [renderdiff](./dup/renderdiff.md)
+    - [backend](./dup/test_backend.md)
+    - [renderdiff](./dup/test_renderdiff.md)
   - [Libraries](./notes/libs.md)
     - [bluegl](./dup/bluegl.md)
     - [bluevk](./dup/bluevk.md)

docs_src/src_mdbook/src/release/README.md

@@ -0,0 +1,4 @@
+# Release
+
+This is a collection of guides for releasing Filament on different distribution platforms, including
+Github, Maven, and CocoaPods.

test/backend/README.md

@@ -1,6 +1,8 @@
 # Backend Tests
 
-This directory contains scripts to run Filament's backend tests using a software rasterizer (Mesa). This is useful for running tests in a continuous integration environment where a GPU might not be available.
+This directory (`/test/backend`) contains scripts to run Filament's backend tests using a software
+rasterizer (Mesa). This is useful for running tests in a continuous integration environment where a
+GPU might not be available.
 
 The `test.sh` script will:
 
@@ -12,5 +14,7 @@ The `test.sh` script will:
 
 The `test.sh` script accepts the following flags:
 
--   `--gtest_filter`: Filters the tests that are run. This is passed directly to the underlying gtest executable.
+-   `--gtest_filter`: Filters the tests that are run. This is passed directly to the underlying
--   `--backend`: Specifies which backend to test. Can be `opengl`, `vulkan`, or a comma-separated list (e.g., `opengl,vulkan`). Defaults to both.
+    gtest executable.
+-   `--backend`: Specifies which backend to test. Can be `opengl`, `vulkan`, or a comma-separated
+    list (e.g., `opengl,vulkan`). Defaults to both.

test/renderdiff/README.md

@@ -1,6 +1,7 @@
 # Rendering Difference Test
 
-This tool is a collections of scripts to run `gltf_viewer` and produce headless renderings.
+This tool (`/test/renderdiff`) is a collections of scripts to run `gltf_viewer` and produce headless
+renderings.
 
 This is mainly useful for continuous integration where GPUs are generally not available on cloud
 machines. To perform software rasterization, these scripts are centered around [Mesa]'s
@@ -104,7 +105,7 @@ it in the following fashion
   ```
 - In the commit message of your working branch on `filament`, add the following line
   ```
-  RDIFF_BBRANCH=my-pr-branch-golden
+  RDIFF_BRANCH=my-pr-branch-golden
   ```
 
 Doing the above has multiple effects: