docs: Describe basename prop in UI documentation

peruukki · peruukki · commit cf64b8d15804 · 2025-02-04T22:58:10.000+02:00
Signed-off-by: Harri Lehtola &lt;peruukki@hotmail.com&gt;
diff --git a/docs/reference/alpha-web-ui.md b/docs/reference/alpha-web-ui.md
@@ -122,7 +122,7 @@ You can use `projectListPromise` to provide a promise that overrides where the F
 
 You can add custom tabs for any of the core Feast objects through the `tabsRegistry`.
 
-```
+```jsx
 const tabsRegistry = {
   RegularFeatureViewCustomTabs: [
     {
@@ -141,3 +141,23 @@ const tabsRegistry = {
 ```
 
 Examples of custom tabs can be found in the `ui/custom-tabs` folder.
+
+**Custom basename**
+
+If you want to serve the UI under a specific URL path instead of at the root,
+you can use the `basename` prop, and it will be forwarded to React Router.
+
+For example, to serve the UI at the `/feast-ui` path:
+
+```jsx
+<FeastUI
+  basename="/feast-ui"
+  feastUIConfigs={{
+    projectListPromise: fetch("/feast-ui/projects-list.json", {
+      headers: {
+        "Content-Type": "application/json",
+      },
+    }).then((res) => res.json())
+  }}
+/>
+```
