Fix build name and typos mentioned in PR 4

.github/workflows/build_houdini.yml

@@ -1,4 +1,4 @@
-name: Build USD Asset Resolvers against Houdini
+name: Build USD Asset Resolvers against Houdini (Linux/Windows)
 
 on:
   release:

README.md

@@ -6,7 +6,7 @@ This repository holds reference implementations for [Usd](https://openusd.org/re
 ## Installation
 To build the various resolvers, follow the instructions in the [install guide](https://lucascheller.github.io/VFX-UsdAssetResolver/installation/requirements.html). 
 
-> :info: This guide currently covers compiling against Houdini on Linux and Windows. Alternatively you can also download a pre-compiled builds on our [release page](https://github.com/LucaScheller/VFX-UsdAssetResolver/releases). To load the resolver, you must specify a few environment variables, see our [environment variables](https://lucascheller.github.io/VFX-UsdAssetResolver/resolvers/overview.html#environment-variables) section for more details. Alternatively you can also source the setup.sh file in the root of this repo when working in Linux to get a pre-configured environment.
+> [!IMPORTANT] This guide currently covers compiling against Houdini on Linux and Windows. Alternatively you can also download a pre-compiled builds on our [release page](https://github.com/LucaScheller/VFX-UsdAssetResolver/releases). To load the resolver, you must specify a few environment variables, see our [environment variables](https://lucascheller.github.io/VFX-UsdAssetResolver/resolvers/overview.html#environment-variables) section for more details. Alternatively you can also source the setup.sh file in the root of this repo when working in Linux to get a pre-configured environment.
 
 ## Feature Overview
 

docs.bat

@@ -1,4 +1,6 @@
-REM Clean existing builds
-rmdir %~dp0docs\book /S /Q
+REM Source setup
+set REPO_ROOT=%~dp0
+REM Clean existing build
+rmdir %REPO_ROOT%docs\book /S /Q
 REM Build book
-mdbook serve --open %~dp0\docs
+mdbook serve --open %REPO_ROOT%docs

docs.sh

@@ -1,12 +1,6 @@
 # Source setup
 export REPO_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && (pwd -W 2> /dev/null || pwd))
-# Clean existing builds
+# Clean existing build
 rm -R ${REPO_ROOT}/docs/book
-# Build Python code based on doc strings. This only needs to be done on API changes.
-# Generate python venv
-# $HFS/python/bin/python -m venv ${REPO_ROOT}/tools/python
-# source ${REPO_ROOT}/tools/python/bin/activate
-# python -m pip install pydoc-markdown
-# This is currently not being used as pydoc-markdown fails to detect all docstrings.
 # Build book
 mdbook serve --open ${REPO_ROOT}/docs

docs/src/resolvers/ExampleSetup/overview.md

@@ -40,7 +40,7 @@ Content of a USD file located at `/workspace/shots/shotA/shotA.usd`
 ```python
 #usda 1.0
 def "testAssetA" (
-    prepend references = @assetA/assetA.usd@</box>
+    prepend references = @assetA/assetA.usd@</asset>
 )
 {
 }
@@ -56,18 +56,18 @@ Content of the USD file located at `/workspace/shots/shotA/shotA_mapping.usd`
 )
 ```
 
-Content of the USD files located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v002.usd`
+Content of the USD files located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v001.usd`
 ```python
 #usda 1.0
-def Cube "box" ()
+def Cube "asset" ()
 {
     double size = 2
 }
 ```
-Content of the USD file located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v001.usd`
+Content of the USD file located at `/workspace/assets/assetA/assetA.usd` and `/workspace/assets/assetA/assetA_v002.usd`
 ```python
 #usda 1.0
-def Cylinder "box" ()
+def Cylinder "asset" ()
 {
 }
 ```

files/box.usda

@@ -1,5 +1,5 @@
 #usda 1.0
-def Cube "box" ()
+def Cube "example" ()
 {
     double size = 2
 }

files/cylinder.usda

@@ -1,4 +1,4 @@
 #usda 1.0
-def Cylinder "box" ()
+def Cylinder "example" ()
 {
 }

files/workspace/assets/assetA/assetA.usd

@@ -1,5 +1,5 @@
 #usda 1.0
-def Cube "box" ()
+def Cube "asset" ()
 {
     double size = 2
 }

files/workspace/assets/assetA/assetA_v001.usd

@@ -1,5 +1,5 @@
 #usda 1.0
-def Cube "box" ()
+def Cube "asset" ()
 {
     double size = 2
 }

files/workspace/assets/assetA/assetA_v002.usd

@@ -1,4 +1,4 @@
 #usda 1.0
-def Cylinder "box" ()
+def Cylinder "asset" ()
 {
 }

files/workspace/shots/shotA/shotA.usd

@@ -1,6 +1,6 @@
 #usda 1.0
 def "testAssetA" (
-    prepend references = @assetA/assetA.usd@</box>
+    prepend references = @assetA/assetA.usd@</asset>
 )
 {
 }