chore: update docs

Orfium · Mar 13, 2024 · cd29627 · cd29627
1 parent ee3d634
commit cd29627
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 1 deletion.
diff --git a/documentation/docs/api/Components/LinkWithStatePassthrough.mdx b/documentation/docs/api/Components/LinkWithStatePassthrough.mdx
@@ -9,6 +9,10 @@ sidebar_position: 3
 import { LinkWithStatePassthrough } from '@orfium/toolbox';
 ```
 
+:::info
+Must be a descendant of [`Router`](https://v5.reactrouter.com/web/api/Router).
+:::
+
 ## Description
 
 A utility component that wraps over React Router's [`Link`](https://v5.reactrouter.com/web/api/Link) component,

diff --git a/documentation/docs/api/Components/NavLinkWithStatePassthrough.mdx b/documentation/docs/api/Components/NavLinkWithStatePassthrough.mdx
@@ -9,6 +9,11 @@ sidebar_position: 3
 import { NavLinkWithStatePassthrough } from '@orfium/toolbox';
 ```
 
+:::info
+Must be a descendant of [`Router`](https://v5.reactrouter.com/web/api/Router).
+:::
+
+
 ## Description
 
 A utility component that wraps over React Router's [`NavLink`](https://v5.reactrouter.com/web/api/NavLink) component,

diff --git a/documentation/docs/api/Components/Navigation.mdx b/documentation/docs/api/Components/Navigation.mdx
@@ -11,6 +11,10 @@ import Type from '../_type-definitions/NavigationProps.md';
 import { Navigation } from '@orfium/toolbox';
 ```
 
+:::info
+Must be a descendant of [`Toolbox`](./Toolbox), [`ThemeProvider`](https://designlab.orfium.com/?path=/docs/design-system-themeprovider--setting-up-a-button-example) and [`Router`](https://v5.reactrouter.com/web/api/Router).
+:::
+
 ## Description
 
 A UI component that handles user navigation both within the current product and among Orfium products. It is comprised of
@@ -47,7 +51,7 @@ navigation links within `Navigation` pass that history state around to one anoth
 URL path as its `href` value.
 :::
 
-:::caution
+:::warning
 If your admin views have navigation of their own (by means of redirects or links), using regular
 [`Link`](https://v5.reactrouter.com/web/api/Link)s, [`NavLink`](https://v5.reactrouter.com/web/api/NavLink)s or
 [`Redirect`](https://v5.reactrouter.com/web/api/Redirect)s without passing around the history state will "break" the

diff --git a/documentation/docs/api/Components/RedirectWithStatePassthrough.mdx b/documentation/docs/api/Components/RedirectWithStatePassthrough.mdx
@@ -9,6 +9,10 @@ sidebar_position: 3
 import { RedirectWithStatePassthrough } from '@orfium/toolbox';
 ```
 
+:::info
+Must be a descendant of [`Router`](https://v5.reactrouter.com/web/api/Router).
+:::
+
 ## Description
 
 A utility component that wraps over React Router's [`Redirect`](https://v5.reactrouter.com/web/api/Redirect) component,

diff --git a/documentation/docs/api/Components/TopBar.mdx b/documentation/docs/api/Components/TopBar.mdx
@@ -11,6 +11,11 @@ import Type from '../_type-definitions/TopBarProps.md';
 import { TopBar } from '@orfium/toolbox';
 ```
 
+:::info
+Must be a descendant of [`Toolbox`](./Toolbox), [`ThemeProvider`](https://designlab.orfium.com/?path=/docs/design-system-themeprovider--setting-up-a-button-example) and [`Router`](https://v5.reactrouter.com/web/api/Router).
+:::
+
+
 ## Description
 
 A UI component that holds other UI elements such as the user menu on the right and an optional utility section on the