docs: rename to developer

monerium · Aug 22, 2024 · 71adc07 · 71adc07
1 parent fb7a7b0
commit 71adc07
Show file tree

Hide file tree

Showing 143 changed files with 439 additions and 817 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -58,7 +58,7 @@ jobs:
         run: |
           git config --global user.name "GitHub Actions"
           git config --global user.email "actions@github.com"
-          git add ./apps/docs/docs
+          git add ./apps/developer/docs/tools/
           git commit -m "docs: update generated documentation"
           git push
 

diff --git a/apps/docs/.gitignore → apps/developer/.gitignore b/apps/docs/.gitignore → apps/developer/.gitignore
diff --git a/apps/docs/README.md → apps/developer/README.md b/apps/docs/README.md → apps/developer/README.md
diff --git a/apps/docs/babel.config.js → apps/developer/babel.config.js b/apps/docs/babel.config.js → apps/developer/babel.config.js
diff --git a/apps/developer/docs/index.md b/apps/developer/docs/index.md
@@ -0,0 +1 @@
+# Welcome
diff --git a/...ct Provider/functions/MoneriumProvider.md → ...ct Provider/functions/MoneriumProvider.md b/...ct Provider/functions/MoneriumProvider.md → ...ct Provider/functions/MoneriumProvider.md
diff --git a/...s/SDK React Provider/functions/useAuth.md → ...s/SDK React Provider/functions/useAuth.md b/...s/SDK React Provider/functions/useAuth.md → ...s/SDK React Provider/functions/useAuth.md
@@ -1,12 +1,12 @@
 # Function: useAuth()
 
-> **useAuth**(): [`UseAuthReturn`](/docs/SDK%20React%20Provider/type-aliases/UseAuthReturn.md)
+> **useAuth**(): [`UseAuthReturn`](/docs/tools/SDK%20React%20Provider/type-aliases/UseAuthReturn.md)
 
 # Redirect to the Monerium auth flow.
 
 ## Returns
 
-[`UseAuthReturn`](/docs/SDK%20React%20Provider/type-aliases/UseAuthReturn.md)
+[`UseAuthReturn`](/docs/tools/SDK%20React%20Provider/type-aliases/UseAuthReturn.md)
 
 - `authorize`  - Redirects to the Monerium auth flow.
 - `isAuthorized` - Whether the user is authorized.

diff --git a/...eact Provider/functions/useAuthContext.md → ...eact Provider/functions/useAuthContext.md b/...eact Provider/functions/useAuthContext.md → ...eact Provider/functions/useAuthContext.md
@@ -1,6 +1,6 @@
 # Function: useAuthContext()
 
-> **useAuthContext**(`params`?): [`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"authContext"`, `AuthContext`\>
+> **useAuthContext**(`params`?): [`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"authContext"`, `AuthContext`\>
 
 # Get the authentication context.
 
@@ -10,13 +10,13 @@
 
 No required parameters.
 
-• **params.query?**: [`QueryOptions`](/docs/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`AuthContext`\>
+• **params.query?**: [`QueryOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`AuthContext`\>
 
 See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"authContext"`, `AuthContext`\>
+[`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"authContext"`, `AuthContext`\>
 
 ## Example
 
@@ -35,7 +35,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/auth-context)
 
-[AuthContext interface](/docs/SDK/interfaces/AuthContext.md)
+[AuthContext interface](/docs/tools/SDK/interfaces/AuthContext.md)
 
 ## Defined in
 

diff --git a/...K React Provider/functions/useBalances.md → ...K React Provider/functions/useBalances.md b/...K React Provider/functions/useBalances.md → ...K React Provider/functions/useBalances.md
@@ -1,6 +1,6 @@
 # Function: useBalances()
 
-> **useBalances**(`params`?): [`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"balances"`, `Balances`[]\>
+> **useBalances**(`params`?): [`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"balances"`, `Balances`[]\>
 
 # Get balances
 
@@ -14,13 +14,13 @@ No required parameters.
 
 Fetch balances for a specific profile.
 
-• **params.query?**: [`QueryOptions`](/docs/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Balances`[]\>
+• **params.query?**: [`QueryOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Balances`[]\>
 
 See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"balances"`, `Balances`[]\>
+[`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"balances"`, `Balances`[]\>
 
 ## Example
 
@@ -39,7 +39,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/profile-balances)
 
-[Balances interface](/docs/SDK/interfaces/Balances.md)
+[Balances interface](/docs/tools/SDK/interfaces/Balances.md)
 
 ## Defined in
 

diff --git a/...eact Provider/functions/useLinkAddress.md → ...eact Provider/functions/useLinkAddress.md b/...eact Provider/functions/useLinkAddress.md → ...eact Provider/functions/useLinkAddress.md
@@ -1,6 +1,6 @@
 # Function: useLinkAddress()
 
-> **useLinkAddress**(`param`): [`MutationResult`](/docs/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
+> **useLinkAddress**(`param`): [`MutationResult`](/docs/tools/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
 
 # Add address to profile.
 When the address has been linked, the relevant profile query will be invalidated and re-fetched.
@@ -9,7 +9,7 @@ When the address has been linked, the relevant profile query will be invalidated
 
 • **param**
 
-• **param.mutation?**: [`MutationOptions`](/docs/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`LinkedAddress`, `Error`, `LinkAddress`\>
+• **param.mutation?**: [`MutationOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`LinkedAddress`, `Error`, `LinkAddress`\>
 
 See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options.
 
@@ -19,7 +19,7 @@ Which profile to link the address.
 
 ## Returns
 
-[`MutationResult`](/docs/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
+[`MutationResult`](/docs/tools/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
 
 ## Example
 
@@ -38,7 +38,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/profile-addresses)
 
-[LinkAddress interface](/docs/SDK/interfaces/LinkAddress.md)
+[LinkAddress interface](/docs/tools/SDK/interfaces/LinkAddress.md)
 
 ## Defined in
 

diff --git a/.../SDK React Provider/functions/useOrder.md → .../SDK React Provider/functions/useOrder.md b/.../SDK React Provider/functions/useOrder.md → .../SDK React Provider/functions/useOrder.md
@@ -1,6 +1,6 @@
 # Function: useOrder()
 
-> **useOrder**(`params`): [`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"order"`, `Order`\>
+> **useOrder**(`params`): [`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"order"`, `Order`\>
 
 # Get single order
 
@@ -12,13 +12,13 @@
 
 The id of the order.
 
-• **params.query?**: [`QueryOptions`](/docs/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Order`\> = `{}`
+• **params.query?**: [`QueryOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Order`\> = `{}`
 
 See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"order"`, `Order`\>
+[`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"order"`, `Order`\>
 
 ## Example
 
@@ -37,7 +37,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/order)
 
-[Order interface](/docs/SDK/interfaces/Order.md)
+[Order interface](/docs/tools/SDK/interfaces/Order.md)
 
 ## Defined in
 

diff --git a/...SDK React Provider/functions/useOrders.md → ...SDK React Provider/functions/useOrders.md b/...SDK React Provider/functions/useOrders.md → ...SDK React Provider/functions/useOrders.md
@@ -1,6 +1,6 @@
 # Function: useOrders()
 
-> **useOrders**(`params`?): [`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"orders"`, `Order`[]\>
+> **useOrders**(`params`?): [`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"orders"`, `Order`[]\>
 
 # Get orders
 
@@ -22,7 +22,7 @@ Filter by the payment memo/reference..
 
 Filter based on the profile ID associated with the order.
 
-• **params.query?**: [`QueryOptions`](/docs/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Order`[]\> = `{}`
+• **params.query?**: [`QueryOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Order`[]\> = `{}`
 
 See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
@@ -36,7 +36,7 @@ Filter based on the blockchain transaction hash.
 
 ## Returns
 
-[`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"orders"`, `Order`[]\>
+[`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"orders"`, `Order`[]\>
 
 ## Example
 
@@ -55,7 +55,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/orders)
 
-[Order interface](/docs/SDK/interfaces/Order.md)
+[Order interface](/docs/tools/SDK/interfaces/Order.md)
 
 ## Defined in
 

diff --git a/...React Provider/functions/usePlaceOrder.md → ...React Provider/functions/usePlaceOrder.md b/...React Provider/functions/usePlaceOrder.md → ...React Provider/functions/usePlaceOrder.md
@@ -1,6 +1,6 @@
 # Function: usePlaceOrder()
 
-> **usePlaceOrder**(`param`): [`MutationResult`](/docs/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"placeOrder"`, `Order`, `Error`, `NewOrder`\>
+> **usePlaceOrder**(`param`): [`MutationResult`](/docs/tools/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"placeOrder"`, `Order`, `Error`, `NewOrder`\>
 
 # Place an order.
 When the order has been placed, the orders query will be invalidated and re-fetched.
@@ -11,7 +11,7 @@ If the order amount is above 15000, a supporting document is required.
 
 • **param** = `{}`
 
-• **param.mutation?**: [`MutationOptions`](/docs/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`Order`, `Error`, `NewOrder`\>
+• **param.mutation?**: [`MutationOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`Order`, `Error`, `NewOrder`\>
 
 See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options.
 
@@ -21,7 +21,7 @@ Supporting document file.
 
 ## Returns
 
-[`MutationResult`](/docs/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"placeOrder"`, `Order`, `Error`, `NewOrder`\>
+[`MutationResult`](/docs/tools/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"placeOrder"`, `Order`, `Error`, `NewOrder`\>
 
 ## Example
 
@@ -40,7 +40,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/post-orders)
 
-[NewOrder type](/docs/SDK/type-aliases/NewOrder.md)
+[NewOrder type](/docs/tools/SDK/type-aliases/NewOrder.md)
 
 ## Defined in
 

diff --git a/...DK React Provider/functions/useProfile.md → ...DK React Provider/functions/useProfile.md b/...DK React Provider/functions/useProfile.md → ...DK React Provider/functions/useProfile.md
@@ -1,6 +1,6 @@
 # Function: useProfile()
 
-> **useProfile**(`params`): [`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profile"`, `Profile`\>
+> **useProfile**(`params`): [`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profile"`, `Profile`\>
 
 # Get single profile
 If no `profileId` is provided, the default profile is used.
@@ -13,13 +13,13 @@ If no `profileId` is provided, the default profile is used.
 
 The id of the profile.
 
-• **params.query?**: [`QueryOptions`](/docs/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Profile`\>
+• **params.query?**: [`QueryOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Profile`\>
 
 See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profile"`, `Profile`\>
+[`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profile"`, `Profile`\>
 
 ## Example
 
@@ -38,7 +38,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/profile)
 
-[Profile interface](/docs/SDK/interfaces/Profile.md)
+[Profile interface](/docs/tools/SDK/interfaces/Profile.md)
 
 ## Defined in
 

diff --git a/...K React Provider/functions/useProfiles.md → ...K React Provider/functions/useProfiles.md b/...K React Provider/functions/useProfiles.md → ...K React Provider/functions/useProfiles.md
@@ -1,6 +1,6 @@
 # Function: useProfiles()
 
-> **useProfiles**(`params`?): [`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profiles"`, `Profile`[]\>
+> **useProfiles**(`params`?): [`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profiles"`, `Profile`[]\>
 
 # Get profiles
 
@@ -10,13 +10,13 @@
 
 No required parameters.
 
-• **params.query?**: [`QueryOptions`](/docs/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Profile`[]\>
+• **params.query?**: [`QueryOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Profile`[]\>
 
 See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profiles"`, `Profile`[]\>
+[`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"profiles"`, `Profile`[]\>
 
 ## Example
 
@@ -35,7 +35,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/profiles)
 
-[Profile interface](/docs/SDK/interfaces/Profile.md)
+[Profile interface](/docs/tools/SDK/interfaces/Profile.md)
 
 ## Defined in
 

diff --git a/...SDK React Provider/functions/useTokens.md → ...SDK React Provider/functions/useTokens.md b/...SDK React Provider/functions/useTokens.md → ...SDK React Provider/functions/useTokens.md
@@ -1,6 +1,6 @@
 # Function: useTokens()
 
-> **useTokens**(`params`?): [`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"tokens"`, `Token`[]\>
+> **useTokens**(`params`?): [`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"tokens"`, `Token`[]\>
 
 # Get tokens
 
@@ -10,13 +10,13 @@
 
 No required parameters.
 
-• **params.query?**: [`QueryOptions`](/docs/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Token`[]\>
+• **params.query?**: [`QueryOptions`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Token`[]\>
 
 See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](/docs/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"tokens"`, `Token`[]\>
+[`QueryResult`](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"tokens"`, `Token`[]\>
 
 ## Example
 
@@ -35,7 +35,7 @@ const {
 
 [API Documentation](https://monerium.dev/api-docs#operation/tokens)
 
-[Token interface](/docs/SDK/interfaces/Token.md)
+[Token interface](/docs/tools/SDK/interfaces/Token.md)
 
 ## Defined in
 

diff --git a/apps/developer/docs/tools/SDK React Provider/index.md b/apps/developer/docs/tools/SDK React Provider/index.md
@@ -0,0 +1,33 @@
+# SDK React Provider
+
+## Provider
+
+- [MoneriumProvider](/docs/tools/SDK%20React%20Provider/functions/MoneriumProvider.md)
+
+## Hooks
+
+- [useAuth](/docs/tools/SDK%20React%20Provider/functions/useAuth.md)
+- [useAuthContext](/docs/tools/SDK%20React%20Provider/functions/useAuthContext.md)
+- [useBalances](/docs/tools/SDK%20React%20Provider/functions/useBalances.md)
+- [useLinkAddress](/docs/tools/SDK%20React%20Provider/functions/useLinkAddress.md)
+- [useOrder](/docs/tools/SDK%20React%20Provider/functions/useOrder.md)
+- [useOrders](/docs/tools/SDK%20React%20Provider/functions/useOrders.md)
+- [usePlaceOrder](/docs/tools/SDK%20React%20Provider/functions/usePlaceOrder.md)
+- [useProfile](/docs/tools/SDK%20React%20Provider/functions/useProfile.md)
+- [useProfiles](/docs/tools/SDK%20React%20Provider/functions/useProfiles.md)
+- [useTokens](/docs/tools/SDK%20React%20Provider/functions/useTokens.md)
+
+## Variables
+
+- [MoneriumContext](/docs/tools/SDK%20React%20Provider/variables/MoneriumContext.md)
+- [keys](/docs/tools/SDK%20React%20Provider/variables/keys.md)
+
+## Type Aliases
+
+- [AuthorizeParams](/docs/tools/SDK%20React%20Provider/type-aliases/AuthorizeParams.md)
+- [MutationOptions](/docs/tools/SDK%20React%20Provider/type-aliases/MutationOptions.md)
+- [MutationResult](/docs/tools/SDK%20React%20Provider/type-aliases/MutationResult.md)
+- [QueryOptions](/docs/tools/SDK%20React%20Provider/type-aliases/QueryOptions.md)
+- [QueryResult](/docs/tools/SDK%20React%20Provider/type-aliases/QueryResult.md)
+- [SdkInstance](/docs/tools/SDK%20React%20Provider/type-aliases/SdkInstance.md)
+- [UseAuthReturn](/docs/tools/SDK%20React%20Provider/type-aliases/UseAuthReturn.md)
diff --git a/... Provider/type-aliases/AuthorizeParams.md → ... Provider/type-aliases/AuthorizeParams.md b/... Provider/type-aliases/AuthorizeParams.md → ... Provider/type-aliases/AuthorizeParams.md
diff --git a/... Provider/type-aliases/MutationOptions.md → ... Provider/type-aliases/MutationOptions.md b/... Provider/type-aliases/MutationOptions.md → ... Provider/type-aliases/MutationOptions.md
@@ -60,9 +60,9 @@ useMutationHook({
 
 ## Used By
 
-[useLinkAddress](/docs/SDK%20React%20Provider/functions/useLinkAddress.md)
+[useLinkAddress](/docs/tools/SDK%20React%20Provider/functions/useLinkAddress.md)
 
-[usePlaceOrder](/docs/SDK%20React%20Provider/functions/usePlaceOrder.md)
+[usePlaceOrder](/docs/tools/SDK%20React%20Provider/functions/usePlaceOrder.md)
 
 ## Defined in
 

diff --git a/...t Provider/type-aliases/MutationResult.md → ...t Provider/type-aliases/MutationResult.md b/...t Provider/type-aliases/MutationResult.md → ...t Provider/type-aliases/MutationResult.md
@@ -55,9 +55,9 @@ const {
 
 ## Used By
 
-[useLinkAddress](/docs/SDK%20React%20Provider/functions/useLinkAddress.md)
+[useLinkAddress](/docs/tools/SDK%20React%20Provider/functions/useLinkAddress.md)
 
-[usePlaceOrder](/docs/SDK%20React%20Provider/functions/usePlaceOrder.md)
+[usePlaceOrder](/docs/tools/SDK%20React%20Provider/functions/usePlaceOrder.md)
 
 ## Defined in