refactor: sdk and connector guides

logto-io · charIeszhao · Jan 6, 2025 · Jan 2, 2025 · Jan 4, 2025 · Jan 4, 2025
commit 1b35b4947b2a88961f5cfa52136e156c6f533ec1
diff --git a/docs/integrations/email/aws-ses/README.mdx b/docs/integrations/email/aws-ses/README.mdx
@@ -5,6 +5,9 @@ sidebar_custom_props:
   description: Amazon SES is a cloud email service provider that can integrate into any application for bulk email sending.
   logoFilename: 'aws.svg'
   darkLogoFilename: 'aws-dark.svg'
+tutorial_name: AWS SES
+tutorial_config_name: AWS SES email connector
+tutorial_sign_up_identifier: Email address
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/email/sendgrid/README.mdx b/docs/integrations/email/sendgrid/README.mdx
@@ -4,6 +4,9 @@ sidebar_label: SendGrid Email
 sidebar_custom_props:
   description: SendGrid is a communication platform for transactional and marketing email.
   logoFilename: 'sendgrid.svg'
+tutorial_name: SendGrid
+tutorial_config_name: SendGrid email connector
+tutorial_sign_up_identifier: Email address
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/sms/twilio/README.mdx b/docs/integrations/sms/twilio/README.mdx
@@ -4,6 +4,9 @@ sidebar_label: Twilio SMS
 sidebar_custom_props:
   description: Twilio provides programmable communication tools for phone calls and messages.
   logoFilename: 'twilio.svg'
+tutorial_name: Twilio
+tutorial_config_name: Twilio SMS connector
+tutorial_sign_up_identifier: Phone number
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/apple/README.mdx b/docs/integrations/social/apple/README.mdx
@@ -4,6 +4,7 @@ sidebar_label: Apple
 sidebar_custom_props:
   darkLogoFilename: 'apple-dark.svg'
   description: Apple is a multinational high-end provider of hardware and software.
+tutorial_config_name: Apple Sign-in
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/azure-ad/README.mdx b/docs/integrations/social/azure-ad/README.mdx
@@ -3,6 +3,8 @@ slug: /integrations/azuread
 sidebar_label: Microsoft
 sidebar_custom_props:
   description: Microsoft Azure Active Directory is a leading AD provider.
+tutorial_name: Azure AD
+tutorial_config_name: Azure AD
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/discord/README.mdx b/docs/integrations/social/discord/README.mdx
@@ -3,6 +3,7 @@ slug: /integrations/discord
 sidebar_label: Discord
 sidebar_custom_props:
   description: Discord is the easiest way to talk over voice, video, and text.
+tutorial_config_name: Discord OAuth app
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/facebook/README.mdx b/docs/integrations/social/facebook/README.mdx
@@ -3,6 +3,7 @@ slug: /integrations/facebook
 sidebar_label: Facebook
 sidebar_custom_props:
   description: Facebook is a worldwide social media platform with billions of users.
+tutorial_config_name: Facebook login
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/github/README.mdx b/docs/integrations/social/github/README.mdx
@@ -4,6 +4,7 @@ sidebar_label: GitHub
 sidebar_custom_props:
   darkLogoFilename: 'github-dark.svg'
   description: GitHub is an online community for software development and version control.
+tutorial_config_name: GitHub OAuth app
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/google/README.mdx b/docs/integrations/social/google/README.mdx
@@ -3,6 +3,7 @@ slug: /integrations/google
 sidebar_label: Google
 sidebar_custom_props:
   description: Google is a principal search engine technology and email service provider.
+tutorial_config_name: Google OAuth app
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/hugging-face/README.mdx b/docs/integrations/social/hugging-face/README.mdx
@@ -3,6 +3,7 @@ slug: /integrations/huggingface
 sidebar_label: Hugging Face
 sidebar_custom_props:
   description: Hugging Face is a machine learning (ML) and data science platform and community that helps users build, deploy and train machine learning models.
+tutorial_config_name: Hugging Face OAuth app
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/kakao/README.mdx b/docs/integrations/social/kakao/README.mdx
@@ -3,6 +3,7 @@ slug: /integrations/kakao
 sidebar_label: Kakao
 sidebar_custom_props:
   description: Kakao is a famous social network service provider in South Korea.
+tutorial_config_name: Kakao login
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/naver/README.mdx b/docs/integrations/social/naver/README.mdx
@@ -3,6 +3,7 @@ slug: /integrations/naver
 sidebar_label: Naver
 sidebar_custom_props:
   description: Naver is the most leading internet service provider in South Korea.
+tutorial_config_name: Naver login
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/oauth2/README.mdx b/docs/integrations/social/oauth2/README.mdx
@@ -4,6 +4,8 @@ sidebar_label: OAuth 2.0 (Social)
 sidebar_custom_props:
   description: The OAuth 2.0 authorization framework enables a third-party application to obtain limited access to an HTTP service.
   logoFilename: 'oauth.svg'
+tutorial_name: OAuth2
+tutorial_config_name: Standard OAuth 2.0 app
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/oidc/README.mdx b/docs/integrations/social/oidc/README.mdx
@@ -3,6 +3,8 @@ slug: /integrations/oidc
 sidebar_label: OIDC (Social)
 sidebar_custom_props:
   description: OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0 protocol.
+tutorial_name: OIDC
+tutorial_config_name: Standard OIDC app
 ---
 
 import GuideTip from '../../fragments/_guide-tip.mdx';

diff --git a/docs/integrations/social/saml/README.mdx b/docs/integrations/social/saml/README.mdx
@@ -0,0 +1,31 @@
+---
+unlisted: true
+slug: /integrations/saml
+sidebar_label: SAML (Social)
+sidebar_custom_props:
+  description: SAML is an open protocol for authentication that is designed to be simple and secure.
+tutorial_name: SAML
+tutorial_config_name: Standard SAML app
+---
+
+import GuideTip from '../../fragments/_guide-tip.mdx';
+
+import Integration from './_integration.mdx';
+
+# Set up social login with SAML
+
+The official Logto connector for SAML protocol.
+
+<GuideTip />
+
+## Get started \{#get-started}
+
+The SAML connector enables Logto's connection to an arbitrary social identity provider that supports SAML protocol.
+
+:::note
+
+SAML connector is a special kind of connector in Logto, you can add a few SAML-based connector.
+
+:::
+
+<Integration />
diff --git a/docs/quick-starts/fragments/_checkpoint-test-your-application.md b/docs/quick-starts/fragments/_checkpoint-test-your-application.md
@@ -5,4 +5,4 @@ Now, you can test your application:
 1. Run your application, you will see the sign-in button.
 2. Click the sign-in button, the SDK will init the sign-in process and redirect you to the Logto sign-in page.
 3. After you signed in, you will be redirected back to your application and see the sign-out button.
-4. Click the sign-out button to clear local storage and sign out.
+4. Click the sign-out button to clear token storage and sign out.
diff --git a/docs/quick-starts/framework/android/README.mdx b/docs/quick-starts/framework/android/README.mdx
@@ -3,6 +3,10 @@ slug: /quick-starts/android
 sidebar_label: Android (Kotlin / Java)
 sidebar_custom_props:
   description: Android integration guide.
+language: kotlin/java
+official_link: https://developer.android.com
+app_type: Native app
+framework: Android (Kotlin) / Android (Java)
 ---
 
 import CodeBlock from '@theme/CodeBlock';

diff --git a/docs/quick-starts/framework/android/_for-tutorial.mdx b/docs/quick-starts/framework/android/_for-tutorial.mdx
@@ -0,0 +1,30 @@
+import redirectUriFigure from '@site/docs/quick-starts/assets/android-redirect-uri.png';
+import Checkpoint from '@site/docs/quick-starts/fragments/_checkpoint-test-your-application.md';
+import ConfigureRedirectUri from '@site/docs/quick-starts/fragments/_configure-redirect-uri.mdx';
+import GuideTip from '@site/docs/quick-starts/framework/android/_guide-tip.md';
+import ImplementSignInAndSignOut from '@site/docs/quick-starts/framework/android/_implement-sign-in-and-sign-out.mdx';
+import InitLogtoClient from '@site/docs/quick-starts/framework/android/_init-logto-client.md';
+import Installation from '@site/docs/quick-starts/framework/android/_installation.mdx';
+
+<GuideTip />
+
+### Installation \{#installation}
+
+<Installation />
+
+### Init LogtoClient \{#init-logtoclient}
+
+<InitLogtoClient />
+
+### Configure redirect URI \{#configure-redirect-uri}
+
+<ConfigureRedirectUri
+  figureSrc={redirectUriFigure}
+  redirectUri="io.logto.android://io.logto.sample/callback"
+/>
+
+### Implement sign-in and sign-out \{#implement-sign-in-and-sign-out}
+
+<ImplementSignInAndSignOut />
+
+<Checkpoint />
diff --git a/docs/quick-starts/framework/android/_implement-sign-in.mdx b/docs/quick-starts/framework/android/_implement-sign-in.mdx
diff --git a/docs/quick-starts/framework/android/_implement-sign-out.md b/docs/quick-starts/framework/android/_implement-sign-out.md
diff --git a/docs/quick-starts/framework/dotnet-blazor-server/README.mdx b/docs/quick-starts/framework/dotnet-blazor-server/README.mdx
@@ -4,6 +4,10 @@ sidebar_label: .NET Core (Blazor Server)
 sidebar_custom_props:
   logoFilename: 'dotnet-blazor.svg'
   description: Integrate Logto into your .NET Core Blazor Server app.
+language: c#
+official_link: https://learn.microsoft.com/en-us/aspnet/core/blazor/hosting-models?view=aspnetcore-9.0#blazor-server
+app_type: Traditional web
+framework: .Net Core (Blazor Server)
 ---
 
 import ApiResourcesDescription from '../../fragments/_api-resources-description.md';

diff --git a/docs/quick-starts/framework/dotnet-blazor-server/_for-tutorial.mdx b/docs/quick-starts/framework/dotnet-blazor-server/_for-tutorial.mdx
@@ -0,0 +1,40 @@
+import AddRoutes from '@site/docs/quick-starts/framework/dotnet-blazor-server/_add-routes.md';
+import AuthorizeViewComponent from '@site/docs/quick-starts/framework/dotnet-blazor-server/_authorize-view-component.md';
+import ImplementButtons from '@site/docs/quick-starts/framework/dotnet-blazor-server/_implement-buttons.md';
+import AddAuthentication from '@site/docs/quick-starts/framework/dotnet-mvc/_add-authentication.md';
+import ConfigureRedirectUris from '@site/docs/quick-starts/framework/dotnet-mvc/_configure-redirect-uris.mdx';
+import GuideTip from '@site/docs/quick-starts/framework/dotnet-mvc/_guide-tip.md';
+import Installation from '@site/docs/quick-starts/framework/dotnet-mvc/_installation.md';
+import SignInAndSignOutFlows from '@site/docs/quick-starts/framework/dotnet-mvc/_sign-in-and-sign-out-flows.mdx';
+
+<GuideTip />
+
+### Installation \{#installation}
+
+<Installation />
+
+### Add Logto authentication \{#add-logto-authentication}
+
+<AddAuthentication />
+
+### Sign-in and sign-out flows \{#sign-in-and-sign-out-flows}
+
+<SignInAndSignOutFlows />
+
+### Configure redirect URIs \{#configure-redirect-uris}
+
+<ConfigureRedirectUris />
+
+### Add routes \{#add-routes}
+
+<AddRoutes />
+
+### Implement sign-in/sign-out buttons \{#implement-sign-insign-out-buttons}
+
+<ImplementButtons />
+
+### The `<AuthorizeView />` component \{#the-authorizeview--component}
+
+<AuthorizeViewComponent />
+
+<Checkpoint />
diff --git a/docs/quick-starts/framework/dotnet-blazor-wasm/README.mdx b/docs/quick-starts/framework/dotnet-blazor-wasm/README.mdx
@@ -4,6 +4,11 @@ sidebar_label: .NET Core (Blazor WASM)
 sidebar_custom_props:
   logoFilename: 'dotnet-blazor.svg'
   description: Integrate Logto into your .NET Core Blazor WebAssembly app.
+language: c#
+official_link: https://learn.microsoft.com/en-us/aspnet/core/blazor/hosting-models#blazor-webassembly
+app_type: Single page app
+framework: .NET Core (Blazor WebAssembly)
+tutorial_name: .NET Core (Blazor WebAssembly)
 ---
 
 import FurtherReadings from '../../fragments/_further-readings.md';

diff --git a/docs/quick-starts/framework/dotnet-blazor-wasm/_for-tutorial.mdx b/docs/quick-starts/framework/dotnet-blazor-wasm/_for-tutorial.mdx
@@ -0,0 +1,13 @@
+import GuideTip from '@site/docs/quick-starts/framework/dotnet-blazor-wasm/_guide-tip.md';
+import Installation from '@site/docs/quick-starts/framework/dotnet-blazor-wasm/_installation.md';
+import Integration from '@site/docs/quick-starts/framework/dotnet-blazor-wasm/_integration.mdx';
+
+<GuideTip />
+
+### Installation \{#installation}
+
+<Installation />
+
+<Integration />
+
+<Checkpoint />
diff --git a/docs/quick-starts/framework/dotnet-mvc/README.mdx b/docs/quick-starts/framework/dotnet-mvc/README.mdx
@@ -4,6 +4,10 @@ sidebar_label: .NET Core (MVC)
 sidebar_custom_props:
   logoFilename: 'dotnet-core.svg'
   description: Integrate Logto into your .NET Core web app with Model-View-Controller (MVC).
+language: c#
+official_link: https://dotnet.microsoft.com/apps/aspnet/mvc
+app_type: Traditional web
+framework: .NET Core (MVC)
 ---
 
 import ApiResourcesDescription from '../../fragments/_api-resources-description.md';