From 0ac501173e6d2125048fd1532372f854bba76993 Mon Sep 17 00:00:00 2001 From: Gao Sun Date: Tue, 14 Jun 2022 16:27:25 +0800 Subject: [PATCH] docs(en-US): polish content --- .../docs/docs/tutorial/get-started/README.md | 8 ++++---- .../tutorial/get-started/check-out-demo.md | 2 +- .../create-and-integrate-the-first-app.mdx | 18 +++++++++++++----- .../README.md | 2 +- .../android.mdx | 0 .../components/AppNote.tsx | 0 .../components/SignInNote.tsx | 0 .../{integrate-sdk => integrate-logto}/ios.mdx | 0 .../react.mdx | 0 .../{integrate-sdk => integrate-logto}/vue.mdx | 0 10 files changed, 19 insertions(+), 11 deletions(-) rename packages/docs/docs/tutorial/{integrate-sdk => integrate-logto}/README.md (96%) rename packages/docs/docs/tutorial/{integrate-sdk => integrate-logto}/android.mdx (100%) rename packages/docs/docs/tutorial/{integrate-sdk => integrate-logto}/components/AppNote.tsx (100%) rename packages/docs/docs/tutorial/{integrate-sdk => integrate-logto}/components/SignInNote.tsx (100%) rename packages/docs/docs/tutorial/{integrate-sdk => integrate-logto}/ios.mdx (100%) rename packages/docs/docs/tutorial/{integrate-sdk => integrate-logto}/react.mdx (100%) rename packages/docs/docs/tutorial/{integrate-sdk => integrate-logto}/vue.mdx (100%) diff --git a/packages/docs/docs/tutorial/get-started/README.md b/packages/docs/docs/tutorial/get-started/README.md index d6e996103..30e1499e9 100644 --- a/packages/docs/docs/tutorial/get-started/README.md +++ b/packages/docs/docs/tutorial/get-started/README.md @@ -4,12 +4,12 @@ sidebar_position: 2 # Get Started -Before we start, it'll be good to know how Logto works. To simplify, we divide Logto into four parts: Admin Console, Sign-in Experience, Core Service, and SDK. +Before we start, it'll be good to know how Logto works. To simplify, we divide Logto into four parts: Admin Console, Sign-in Experience, Core Service, and SDKs. - **Admin Console** is a web app that will be your friend for customizing sign in and managing users. - **Sign-in Experience** is the UI that directly faces your end-users, including signing in, creating an account, etc. - **Core Service** is the foundation of Logto, which provides essential APIs to support everything else. -- **SDK** is the bridge between your application and Logto. +- **SDKs** are the bridges between your application and Logto. :::note **TBD** need a simple infra figure here @@ -33,8 +33,8 @@ For now, you cannot create multiple admin accounts via Admin Console, and only t On the create account page, enter your username and password to continue. -## Get Started Guide +## "Get Started" Tab -Once we create the admin account, the browser will redirect you to the "Get Started" tab in Admin Console, which shows a few things that let you glance at what Logto can do. +Once you create the admin account, the browser will redirect you to the "Get Started" tab in Admin Console, which shows a few things that Logto can do at a glance. Our tutorial will follow the order you are seeing. So let's begin! diff --git a/packages/docs/docs/tutorial/get-started/check-out-demo.md b/packages/docs/docs/tutorial/get-started/check-out-demo.md index 6c4055be5..c90e1ca52 100644 --- a/packages/docs/docs/tutorial/get-started/check-out-demo.md +++ b/packages/docs/docs/tutorial/get-started/check-out-demo.md @@ -15,5 +15,5 @@ Logto has only one user identity system as the single source of truth, so you ca The app itself is pretty simple: a congrats page with your Username and User ID, followed by a sign-out button. :::tip -Sign out the demo app before proceeding. After finishing the "Customize sign-in experience" section, open the demo app again to see the changes. +Sign out the demo app before further explorations. After finishing the "Customize sign-in experience" section, open the demo app again to see the changes. ::: diff --git a/packages/docs/docs/tutorial/get-started/create-and-integrate-the-first-app.mdx b/packages/docs/docs/tutorial/get-started/create-and-integrate-the-first-app.mdx index 2a67e6ab1..563b4a231 100644 --- a/packages/docs/docs/tutorial/get-started/create-and-integrate-the-first-app.mdx +++ b/packages/docs/docs/tutorial/get-started/create-and-integrate-the-first-app.mdx @@ -8,17 +8,25 @@ import Columns from '@components/Columns'; Click the "Create" button on the right, and the browser will redirect to the Application tab. Then click the "Create Application" button on this page. -In the opening modal, choose which type of application you'd like to integrate and enter the application name, e.g., "Bookstore". +**Step 1** -Here's a brief explanation of each type: +In the opening modal, choose which type of application you'd like to integrate: -- **Native App** is an app that runs in a native environment, e.g., iOS app, Android app. +- **Native App** is an app that runs in a native environment. E.g., iOS app, Android app. - **Single Page App** is an app that runs in a web browser, which updates the page with the new data from the server without loading entire new pages. E.g., React DOM app, Vue app. - **Traditional Web App** is an app that renders and updates pages by the web server alone. E.g., JSP, PHP. -We prepared different tutorials for each application type, and it'll be helpful if you choose the type properly. Meanwhile, Logto offers some official SDKs to bring the integration experience to another level. +We prepared different tutorials for each application type, and it'll be helpful if you choose the type properly. -Pick the tutorial you need from the list below: +**Step 2** + +Enter the application name, e.g., "Bookstore," and click "Create Application." + +**Step 3** + +Ta-da! You just created your first application in Logto. You'll see a congrats page which includes a detailed integration guide. Follow the guide to see what the experience will be in your application. + +Meanwhile, Logto offers some official SDKs to bring the integration experience to another level (introduction included in the guide). You can also pick the guide from the list below if you skip the page by accident: