Restructure docs panel

LucaScheller · Oct 28, 2023 · 578cdd5 · 578cdd5
1 parent 0adedab
commit 578cdd5
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Asset resolvers that can be compiled via this repository:
 - **Python Resolver** - Python based implementation of the file resolver. The goal of this resolver is to enable easier RnD by running all resolver and resolver context related methods in Python. It can be used to quickly inspect resolve calls and to setup prototypes of resolvers that can then later be re-written in C++ as it is easier to code database interactions in Python for initial research.
 - **Cached Resolver** - Still work in progress, more info soon.
 - **Http Resolver** - A proof of concept http resolver. This is kindly provided and maintained by @charlesfleche in the [arHttp: Offloads USD asset resolution to an HTTP server
-](https://github.com/charlesfleche/arHttp) repository. For documentation, feature suggestions and bug reports, please file a ticket there. This repo handles the auto-compilation against DCCs and exposing to the update manager UI.
+](https://github.com/charlesfleche/arHttp) repository. For documentation, feature suggestions and bug reports, please file a ticket there. This repo handles the auto-compilation against DCCs and exposing to the automatic installation update manager UI.
 
 For more information check out the [building guide](https://lucascheller.github.io/VFX-UsdAssetResolver/installation/building.html) as well as the [individual resolvers](https://lucascheller.github.io/VFX-UsdAssetResolver/resolvers/overview.html) to see their full functionality.
 

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -11,8 +11,12 @@
     - [Requirements](./installation/requirements.md)
     - [Building/Deployment](./installation/building.md)
 - [Resolvers](./resolvers/overview.md)
-    - [File Resolver](./resolvers/FileResolver/overview.md)
-        - [Python API](./resolvers/FileResolver/PythonAPI.md)
-    - [Python Resolver](./resolvers/PythonResolver/overview.md)
-        - [Python API](./resolvers/PythonResolver/PythonAPI.md)
+    - [Production Resolvers]()
+        - [File Resolver](./resolvers/FileResolver/overview.md)
+            - [Python API](./resolvers/FileResolver/PythonAPI.md)
+    - [RnD Resolvers]()
+        - [Python Resolver](./resolvers/PythonResolver/overview.md)
+            - [Python API](./resolvers/PythonResolver/PythonAPI.md)
+    - [Proof Of Concept Resolvers]()
+        - [Http Resolver ('arHttp' by @charlesfleche)](./resolvers/HttpResolver/overview.md)
     - [Example Setup](./resolvers/ExampleSetup/overview.md)
diff --git a/docs/src/overview.md b/docs/src/overview.md
@@ -18,6 +18,8 @@ We also offer a quick install method for Houdini that does the download of the c
 Asset resolvers that can be compiled via this repository:
 - **File Resolver** - A file system based resolver similar to the default resolver with support for custom mapping pairs as well as at runtime modification and refreshing.
 - **Python Resolver** - Python based implementation of the file resolver. The goal of this resolver is to enable easier RnD by running all resolver and resolver context related methods in Python. It can be used to quickly inspect resolve calls and to setup prototypes of resolvers that can then later be re-written in C++ as it is easier to code database interactions in Python for initial research.
+- **Http Resolver** - A proof of concept http resolver. This is kindly provided and maintained by @charlesfleche in the [arHttp: Offloads USD asset resolution to an HTTP server
+](https://github.com/charlesfleche/arHttp) repository. For documentation, feature suggestions and bug reports, please file a ticket there. This repo handles the auto-compilation against DCCs and exposing to the automatic installation update manager UI.
 
 For more information check out the [building guide](./installation/building.md) as well as the [individual resolvers](./resolvers/overview.md) to see their full functionality.
 

diff --git a/docs/src/resolvers/HttpResolver/overview.md b/docs/src/resolvers/HttpResolver/overview.md
@@ -0,0 +1,8 @@
+# Http Resolver (arHttp @charlesfleche)
+
+This is a proof of concept http resolver. This is kindly provided and maintained by @charlesfleche in the [arHttp: Offloads USD asset resolution to an HTTP server
+](https://github.com/charlesfleche/arHttp) repository. 
+
+For documentation, feature suggestions and bug reports, please file a ticket there. 
+
+This repo handles the auto-compilation against DCCs and exposing to the automatic installation update manager UI.
diff --git a/docs/theme/ext/css/custom.css b/docs/theme/ext/css/custom.css
@@ -22,7 +22,7 @@ ol.chapter li ol.section li.chapter-item.expanded a.active {
     display: inline-block;
     border-left: .25rem solid transparent;
     border-left-color: var(--inline-code-color);
-    padding: .35rem 1rem .35rem 1.25rem;
+    padding: .35rem 1rem .35rem .25rem;
     box-sizing: border-box;
 }
 

diff --git a/setup.sh b/setup.sh
@@ -5,7 +5,7 @@ then
     export REPO_SOURCED=1
     export REPO_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")" &> /dev/null && (pwd -W 2> /dev/null || pwd))
     # Define Resolver > Has to be one of 'fileResolver'/'pythonResolver'/'cachedResolver'/'httpResolver'
-    export RESOLVER_NAME=fileResolver
+    export RESOLVER_NAME=httpResolver
     export RESOLVER_NAME_UPPERCASE=$(echo ${RESOLVER_NAME} | tr '[:lower:]' '[:upper:]')
     # Source Houdini (This defines what Houdini version to compile against)
     pushd /opt/hfs19.5 > /dev/null