feat: branded documentation

Orfium · Oct 23, 2023 · 7bf9dde · 7bf9dde
1 parent ba85d12
commit 7bf9dde
Show file tree

Hide file tree

Showing 30 changed files with 124 additions and 70 deletions.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -6,6 +6,7 @@ on:
       - 'master'
       - 'next'
       - 'v3.x'
+      - '**'
 
 jobs:
   deploy-review-app:

diff --git a/documentation/docs/api/Components/LinkWithStatePassthrough.mdx b/documentation/docs/api/Components/LinkWithStatePassthrough.mdx
@@ -3,10 +3,11 @@ id: "LinkWithStatePassthrough"
 title: "LinkWithStatePassthrough"
 sidebar_label: "LinkWithStatePassthrough"
 sidebar_position: 3
-custom_edit_url: null
 ---
 
-`import { LinkWithStatePassthrough } from '@orfium/toolbox';`
+```ts
+import { LinkWithStatePassthrough } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Components/NavLinkWithStatePassthrough.mdx b/documentation/docs/api/Components/NavLinkWithStatePassthrough.mdx
@@ -3,10 +3,11 @@ id: "NavLinkWithStatePassthrough"
 title: "NavLinkWithStatePassthrough"
 sidebar_label: "NavLinkWithStatePassthrough"
 sidebar_position: 3
-custom_edit_url: null
 ---
 
-`import { NavLinkWithStatePassthrough } from '@orfium/toolbox';`
+```ts
+import { NavLinkWithStatePassthrough } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Components/Navigation.mdx b/documentation/docs/api/Components/Navigation.mdx
@@ -3,12 +3,13 @@ id: 'Navigation'
 title: 'Navigation'
 sidebar_label: 'Navigation'
 sidebar_position: 1
-custom_edit_url: null
 ---
 
 import Type from '../_type-definitions/NavigationProps.md';
 
-`import { Navigation } from '@orfium/toolbox';`
+```ts
+import { Navigation } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Components/RedirectWithStatePassthrough.mdx b/documentation/docs/api/Components/RedirectWithStatePassthrough.mdx
@@ -3,10 +3,11 @@ id: "RedirectWithStatePassthrough"
 title: "RedirectWithStatePassthrough"
 sidebar_label: "RedirectWithStatePassthrough"
 sidebar_position: 3
-custom_edit_url: null
 ---
 
-`import { RedirectWithStatePassthrough } from '@orfium/toolbox';`
+```ts
+import { RedirectWithStatePassthrough } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Components/Toolbox.mdx b/documentation/docs/api/Components/Toolbox.mdx
@@ -3,12 +3,13 @@ id: 'Toolbox'
 title: 'Toolbox'
 sidebar_label: 'Toolbox'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
 import Type from '../_type-definitions/ToolboxProps.md';
 
-`import { Toolbox } from '@orfium/toolbox';`
+```ts
+import { Toolbox } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Components/TopBar.mdx b/documentation/docs/api/Components/TopBar.mdx
@@ -3,12 +3,13 @@ id: 'TopBar'
 title: 'TopBar'
 sidebar_label: 'TopBar'
 sidebar_position: 2
-custom_edit_url: null
 ---
 
 import Type from '../_type-definitions/TopBarProps.md';
 
-`import { TopBar } from '@orfium/toolbox';`
+```ts
+import { TopBar } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Hooks/useAuthentication.mdx b/documentation/docs/api/Hooks/useAuthentication.mdx
@@ -3,12 +3,13 @@ id: 'useAuthentication'
 title: 'useAuthentication'
 sidebar_label: 'useAuthentication'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
 import Type from '../_type-definitions/AuthenticationContextValue.md';
 
-`import { useAuthentication } from '@orfium/toolbox';`
+```ts
+import { useAuthentication } from '@orfium/toolbox';
+```
 
 :::info
 Only descendants of [`Toolbox`](../components/Toolbox) can use this hook.

diff --git a/documentation/docs/api/Hooks/useData.md b/documentation/docs/api/Hooks/useData.md
@@ -7,10 +7,11 @@ title: 'useData<
 >'
 sidebar_label: 'useData'
 sidebar_position: 10
-custom_edit_url: null
 ---
 
-`import { useData } from '@orfium/toolbox';`
+```ts
+import { useData } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Hooks/useDataPagination.md b/documentation/docs/api/Hooks/useDataPagination.md
@@ -7,10 +7,11 @@ title: 'useDataPagination<
 >'
 sidebar_label: 'useDataPagination'
 sidebar_position: 10
-custom_edit_url: null
 ---
 
-`import { useDataPagination } from '@orfium/toolbox';`
+```ts
+import { useDataPagination } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Hooks/useDeferredValue.md b/documentation/docs/api/Hooks/useDeferredValue.md
@@ -3,10 +3,11 @@ id: 'useDeferredValue'
 title: 'useDeferredValue<T>'
 sidebar_label: 'useDeferredValue'
 sidebar_position: 4
-custom_edit_url: null
 ---
 
-`import { useDeferredValue } from '@orfium/toolbox';`
+```ts
+import { useDeferredValue } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Hooks/useOrfiumProducts.mdx b/documentation/docs/api/Hooks/useOrfiumProducts.mdx
@@ -3,12 +3,13 @@ id: 'useOrfiumProducts'
 title: 'useOrfiumProducts'
 sidebar_label: 'useOrfiumProducts'
 sidebar_position: 2
-custom_edit_url: null
 ---
 
 import Type from '../_type-definitions/OrfiumProductsContextValue.md';
 
-`import { useOrfiumProducts } from '@orfium/toolbox';`
+```ts
+import { useOrfiumProducts } from '@orfium/toolbox';
+```
 
 :::info
 Only descendants of [`Toolbox`](../components/Toolbox) can use this hook.

diff --git a/documentation/docs/api/Hooks/useOrganizations.mdx b/documentation/docs/api/Hooks/useOrganizations.mdx
@@ -3,12 +3,13 @@ id: 'useOrganizations'
 title: 'useOrganizations'
 sidebar_label: 'useOrganizations'
 sidebar_position: 1
-custom_edit_url: null
 ---
 
 import Type from '../_type-definitions/OrganizationsContextValue.md';
 
-`import { useOrganizations } from '@orfium/toolbox';`
+```ts
+import { useOrganizations } from '@orfium/toolbox';
+```
 
 :::info
 Only descendants of [`Toolbox`](../components/Toolbox) can use this hook.

diff --git a/documentation/docs/api/Hooks/useSafeContext.md b/documentation/docs/api/Hooks/useSafeContext.md
@@ -3,10 +3,11 @@ id: 'useSafeContext'
 title: 'useSafeContext<T>'
 sidebar_label: 'useSafeContext'
 sidebar_position: 11
-custom_edit_url: null
 ---
 
-`import { useSafeContext } from '@orfium/toolbox';`
+```ts
+import { useSafeContext } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Hooks/useSafeDispatch.md b/documentation/docs/api/Hooks/useSafeDispatch.md
@@ -3,10 +3,11 @@ id: "useSafeDispatch"
 title: "useSafeDispatch<T>"
 sidebar_label: "useSafeDispatch"
 sidebar_position: 11
-custom_edit_url: null
 ---
 
-`import { useSafeDispatch } from '@orfium/toolbox';`
+```ts
+import { useSafeDispatch } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Hooks/useTopBarUtilitySection.mdx b/documentation/docs/api/Hooks/useTopBarUtilitySection.mdx
@@ -3,12 +3,13 @@ id: 'useTopBarUtilitySection'
 title: 'useTopBarUtilitySection'
 sidebar_label: 'useTopBarUtilitySection'
 sidebar_position: 3
-custom_edit_url: null
 ---
 
 import Type from '../_type-definitions/TopBarUtilitySectionContextValue.md';
 
-`import { useTopBarUtilitySection } from '@orfium/toolbox';`
+```ts
+import { useTopBarUtilitySection } from '@orfium/toolbox';
+```
 
 :::info
 Only descendants of [`Toolbox`](../components/Toolbox) can use this hook.

diff --git a/documentation/docs/api/Utilities/Constants/DEFAULT_NAVBAR_HEIGHT.md b/documentation/docs/api/Utilities/Constants/DEFAULT_NAVBAR_HEIGHT.md
@@ -3,10 +3,11 @@ id: 'DEFAULT_NAVBAR_HEIGHT'
 title: 'DEFAULT_NAVBAR_HEIGHT'
 sidebar_label: 'DEFAULT_NAVBAR_HEIGHT'
 sidebar_position: 100
-custom_edit_url: null
 ---
 
-`import { DEFAULT_NAVBAR_HEIGHT } from '@orfium/toolbox';`
+```ts
+import { DEFAULT_NAVBAR_HEIGHT } from '@orfium/toolbox';
+```
 
 ### Value
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToAUD.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToAUD.mdx
@@ -3,10 +3,11 @@ id: 'formatToAUD'
 title: 'formatToAUD'
 sidebar_label: 'formatToAUD'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { formatToAUD } from '@orfium/toolbox';`
+```ts
+import { formatToAUD } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToCAD.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToCAD.mdx
@@ -3,10 +3,11 @@ id: 'formatToCAD'
 title: 'formatToCAD'
 sidebar_label: 'formatToCAD'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { formatToCAD } from '@orfium/toolbox';`
+```ts
+import { formatToCAD } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToCNY.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToCNY.mdx
@@ -3,10 +3,11 @@ id: 'formatToCNY'
 title: 'formatToCNY'
 sidebar_label: 'formatToCNY'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { formatToCNY } from '@orfium/toolbox';`
+```ts
+import { formatToCNY } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToCurrency.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToCurrency.mdx
@@ -3,10 +3,11 @@ id: 'formatToCurrency'
 title: 'formatToCurrency'
 sidebar_label: 'formatToCurrency'
 sidebar_position: -1
-custom_edit_url: null
 ---
 
-`import { formatToCurrency } from '@orfium/toolbox';`
+```ts
+import { formatToCurrency } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToEUR.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToEUR.mdx
@@ -3,10 +3,11 @@ id: 'formatToEUR'
 title: 'formatToEUR'
 sidebar_label: 'formatToEUR'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { formatToEUR } from '@orfium/toolbox';`
+```ts
+import { formatToEUR } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToGBP.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToGBP.mdx
@@ -3,10 +3,11 @@ id: 'formatToGBP'
 title: 'formatToGBP'
 sidebar_label: 'formatToGBP'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { formatToGBP } from '@orfium/toolbox';`
+```ts
+import { formatToGBP } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToJPY.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToJPY.mdx
@@ -3,10 +3,11 @@ id: 'formatToJPY'
 title: 'formatToJPY'
 sidebar_label: 'formatToJPY'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { formatToJPY } from '@orfium/toolbox';`
+```ts
+import { formatToJPY } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/00-Currencies/formatToUSD.mdx b/documentation/docs/api/Utilities/Functions/00-Currencies/formatToUSD.mdx
@@ -3,10 +3,11 @@ id: 'formatToUSD'
 title: 'formatToUSD'
 sidebar_label: 'formatToUSD'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { formatToUSD } from '@orfium/toolbox';`
+```ts
+import { formatToUSD } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Functions/generateRoutes.mdx b/documentation/docs/api/Utilities/Functions/generateRoutes.mdx
@@ -2,9 +2,12 @@
 id: 'generateRoutes'
 title: 'generateRoutes'
 sidebar_label: 'generateRoutes'
+sidebar_position: 0
 ---
 
-`import { generateRoutes } from '@orfium/toolbox';`
+```ts
+import { generateRoutes } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/api/Utilities/Singletons/orfiumIdBaseInstance.md b/documentation/docs/api/Utilities/Singletons/orfiumIdBaseInstance.md
@@ -3,10 +3,11 @@ id: 'orfiumIdBaseInstance'
 title: 'orfiumIdBaseInstance'
 sidebar_label: 'orfiumIdBaseInstance'
 sidebar_position: 0
-custom_edit_url: null
 ---
 
-`import { orfiumIdBaseInstance } from '@orfium/toolbox';`
+```ts
+import { orfiumIdBaseInstance } from '@orfium/toolbox';
+```
 
 ## Description
 

diff --git a/documentation/docs/tutorials/01-Installation and Usage/Requests/index.md b/documentation/docs/tutorials/01-Installation and Usage/Requests/index.md
@@ -5,8 +5,8 @@
 In order to spare the users having to implement and maintain their own HTTP requests solution, toolbox provides you with
 a couple of options:
 
-- [`orfiumIdBaseInstance`](../../../api/Utilities/Singletons/orfiumIdBaseInstance) - A pre-configured [`CreateAPIInstanceType`](../../../api/Types/CreateAPIInstanceType)
-- [`createAPIInstance`](../../../api/Utilities/Functions/createAPIInstance) - A factory function that creates user-configured [`CreateAPIInstanceType`](../../../api/Types/CreateAPIInstanceType)
+- [`orfiumIdBaseInstance`](../../../api/Utilities/Singletons/orfiumIdBaseInstance) - A pre-configured [`CreateAPIInstanceType`](../../../api/Types/CreateAPIInstanceType) instance
+- [`createAPIInstance`](../../../api/Utilities/Functions/createAPIInstance) - A factory function that creates user-configured [`CreateAPIInstanceType`](../../../api/Types/CreateAPIInstanceType) instances
 
 **_Important Note_** it is important to mention that when [`orfiumIdBaseInstance`](../../../api/Utilities/Singletons/orfiumIdBaseInstance)
 or [`createAPIInstance`](../../../api/Utilities/Functions/createAPIInstance) are used alongside the [`Toolbox`](../../../api/Components/Toolbox)