Skip to content

Commit 63de8d0

Browse files
committed
review fixes and refactoring
1 parent 1be803f commit 63de8d0

22 files changed

+41
-48
lines changed

docs/auth/auth-usage-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ of the file in the `auth` repo: https://github.com/arcana-network/auth/blob/main
1515

1616
Use the {{config.extra.arcana.sdk_name}} to onboard users via social login, allow users to access the in-app {{config.extra.arcana.wallet_name}} and sign blockchain transactions.
1717

18-
[:octicons-cross-reference-16:{ .icon-color } {% include "./text-snippets/authsdkref_url.md" %}](https://authsdk-ref-guide.netlify.app/){ .md-button }
18+
[:octicons-cross-reference-16:{ .icon-color } SDK Reference]({{config.extra.arcana.auth_sdk_ref_url}}){ .md-button }
1919

2020
## Installation
2121

docs/auth/auth-wagmi-usage-guide.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,11 @@ arcana:
66
root_rel_path: ..
77
---
88

9-
<!--
10-
Note, this is a pure markdown file with no mkdocs related tags or keywords. It is a copy
11-
of the file in the `auth` repo: https://github.com/arcana-network/auth/blob/main/usage.md
12-
-->
13-
149
# {{config.extra.arcana.wagmi_sdk_name}} Usage
1510

1611
Use the {{config.extra.arcana.wagmi_sdk_name}} to onboard users in a Wagmi app via social login. Let users instantly access the in-app {{config.extra.arcana.wallet_name}} and sign blockchain transactions.
1712

18-
<!--
19-
Latest auth-wagmi readme update PR not merged hence commenting https://wagmi-authsdk-ref-guide.netlify.app/ for now
20-
-->
21-
22-
[:octicons-cross-reference-16:{ .icon-color } {% include "./text-snippets/wagmi_authsdkref_url.md" %}](https://deploy-preview-28--wagmi-authsdk-ref-guide.netlify.app/){ .md-button }
13+
[:octicons-cross-reference-16:{ .icon-color } SDK Reference]({{config.extra.arcana.wagmi_sdk_ref_url}}){ .md-button }
2314

2415
## Install
2516

docs/auth/introduction/why-auth-sdk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,6 @@ Tailor the user experience for your Web3 applications as per your use case and t
4848

4949
* [Social Login Demo App]({{config.extra.arcana.auth_sdk_demo_url}})
5050
* [[web-auth-usage-guide|{{config.extra.arcana.sdk_name}} Usage Guide]]
51-
* {% include "./text-snippets/authsdkref_url.md" %}
51+
* [Auth SDK Reference]({{config.extra.arcana.auth_sdk_ref_url}})
5252

5353
{% include "./text-snippets/auth_sdk_quicklinks.md" %}

docs/auth/onboard/rainbow/rainbow-custom-ui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,5 @@ Use the `ArcanaConnector` and set up [Wagmi config](https://wagmi.sh/react/getti
6464

6565
* [[web-auth-error-msg|{{config.extra.arcana.sdk_name}} Errors]]
6666
* [[web-auth-usage-guide|{{config.extra.arcana.sdk_name}} Usage Guide]]
67-
* {% include "./text-snippets/authsdkref_url.md" %}
68-
* {% include "./text-snippets/wagmi_authsdkref_url.md" %}
67+
* [Auth SDK Reference]({{config.extra.arcana.auth_sdk_ref_url}})
68+
* [Auth Wagmi SDK Reference]({{config.extra.arcana.wagmi_sdk_ref_url}})

docs/concepts/custom-login-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ This decision is made at the time of SDK integration. This choice is not governe
1818

1919
After installing and integrating with the {{config.extra.arcana.sdk_name}}, create the `AuthProvider`, use `init` function to initialize the provider, create the necessary user interface hooks and call the `loginWithSocial` function with the desired social login provider to onboard users. For email-based onboarding, utilize the `loginWithOTP`(deprecated), `loginWithOTPStart` and `loginWithOTPComplete` functions, which sends users a verification link on the specified user email.
2020

21-
Here is an example of [[google-social-auth|how to onboard users via 'Google' as the social login provider and a custom login UI]]. See {% include "./text-snippets/authsdkref_url.md" %} for more details.
21+
Here is an example of [[google-social-auth|how to onboard users via 'Google' as the social login provider and a custom login UI]]. See [Auth SDK Reference]({{config.extra.arcana.auth_sdk_ref_url}}) for more details.

docs/faq/faq-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ toc_depth: 2
8787

8888
??? an-faq "How does the app access an authenticated user's information such as name, email, login token, the wallet address?"
8989

90-
Apps can use the [`getUser()`](https://authsdk-ref-guide.netlify.app/classes/authprovider#getUser) method to obtain the user's name, email, login token ([[concept-arcana-jwt-token|{{config.extra.arcana.company_name}} JWT Token]], [[concept-did-token|DID Token]]), wallet address, etc. See {% include "./text-snippets/authsdkref_url.md" %} for details.
90+
Apps can use the [`getUser()`](https://authsdk-ref-guide.netlify.app/classes/authprovider#getUser) method to obtain the user's name, email, login token ([[concept-arcana-jwt-token|{{config.extra.arcana.company_name}} JWT Token]], [[concept-did-token|DID Token]]), wallet address, etc. See [Auth SDK Reference]({{config.extra.arcana.auth_sdk_ref_url}}) for details.
9191

9292
??? an-faq "For Twitter, the `getUser()` function of the `AuthProvider` does not always return the user's email?"
9393

File renamed without changes.
File renamed without changes.

docs/quick-start/auth-ca-wagmi-quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To enable social login, you need to integrate with the {{config.extra.arcana.sdk
6666

6767
{% include "./text-snippets/quick-start-deploy.md" %}
6868

69-
For details, see {% include "./text-snippets/wagmi_authsdkref_url.md" %}.
69+
For details, see [Auth Wagmi SDK Reference]({{config.extra.arcana.wagmi_sdk_ref_url}}).
7070

7171
Next, you need to integrate the Web3 app with the {{config.extra.arcana.ca_wagmi_sdk_name}} to enable chain abstracted transactions via unified balance.
7272

docs/setup/config-wallet-chains.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,4 +171,4 @@ For details refer to the [[web-auth-usage-guide#wallet_addethereumchain|{{config
171171
* [[solana-dashboard-user-guide| Configure Solana Chains]]
172172
* [[mvx-dashboard-user-guide| Configure MultiversX Chains]]
173173
* [[near-dashboard-user-guide| Configure Near Chains]]
174-
* {% include "./text-snippets/authsdkref_url.md" %}
174+
* [Auth SDK Reference]({{config.extra.arcana.auth_sdk_ref_url}})

0 commit comments

Comments
 (0)