Skip to content

Commit 7277eff

Browse files
authored
chore: sync lastest docs to 1.x (#404)
1 parent c7f2280 commit 7277eff

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+831
-85
lines changed

β€Žversioned_docs/version-1.x/docs/README.mdxβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@ import basicConcepts from './assets/basic-concepts.png';
3232
<img src={basicConcepts} alt="Basic concepts" width="600px" />
3333

3434
:::info
35-
Admin Console is the easiest way to customize and manage Sign-in Experience and Core Service, and we'll use it across the tutorial. And it is available in both Logto Cloud and Logto Opensource.:::
35+
Admin Console is the easiest way to customize and manage Sign-in Experience and Core Service, and we'll use it across the tutorial. And it is available in both [Logto Cloud](https://cloud.logto.io/) and Logto Open-Source.
36+
:::

β€Žversioned_docs/version-1.x/docs/recipes/configure-connectors/configure-social-connector.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Follow the README to compose the connector config with little effort.
3434
- **Naver** [Universal connector](https://github.com/logto-io/connectors/tree/master/packages/connector-naver)
3535
- **Microsoft Azure AD** [Universal connector](https://github.com/logto-io/connectors/tree/master/packages/connector-azuread)
3636

37-
:::About the platform of Social connector
37+
:::info About the platform of Social connector
3838
You may find that some connectors do not have a secondary choice of platform, such as Google, Facebook, and GitHub. These connectors' _platform_ are _Universal_. Explore _[platform_ description](https://docs.logto.io/docs/references/connectors/#platform) to know more.
3939

4040
Choose a proper _platform_ from either _Web_ or _Native_ for connectors to fit your use case. You can set up a single _Native_ connector w/o adding a _Web_ connector if you only provide native mobile apps and vice versa.

β€Žversioned_docs/version-1.x/docs/recipes/create-your-connector/connector-implementation-guide.mdxβ€Ž

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -100,31 +100,6 @@ The interface is defined as `GetUserInfo` in [`@logto/connector-kit`](https://gi
100100

101101
For sign-in purposes, you can retrieve necessary information using the `getSession` function.
102102

103-
:::tip
104-
To handle sign-in related data that needs to be shared across multiple APIs, you can use the `getSession` and `setSession` functions. On the other hand, if you need to store and retrieve key-value data to the database for longer-term use, you can use the `get` and `set` methods.
105-
106-
It's important to understand the purpose of `getSession` and `setSession`. These functions are primarily used for manipulating sign-in related information for cross-API pass. For example, when sending an authorization request, you may need to attach essential information such as `nonce`. As the `getAuthorizationUri` and `getUserInfo` methods are separated and located in different APIs within Logto core, it's necessary to pass this information across APIs. Since the API is stateless, the `getSession` and `setSession` functions can be used to persist the data throughout the user's session.
107-
108-
On the other hand, the `get` and `set` methods are used to store and retrieve key-value information in the database for long-term use. For example, you might use these methods to save and load an application-level access token and refresh token, which should not be requested frequently.
109-
110-
Here is an example of how to use the `set` and `get` methods (suppose that we start with an empty DB):
111-
112-
```typescript
113-
// Set a value
114-
const key = 'userPreferences';
115-
const value = { theme: 'dark', language: 'en' };
116-
await set(key, value);
117-
118-
// Get a value
119-
const retrievedValue = await get(key);
120-
console.log(retrievedValue); // { theme: 'dark', language: 'en' }
121-
const valueOfUnknownKey = await get('unknownKey');
122-
console.log(valueOfUnknownKey); // null
123-
```
124-
125-
It is important to note that we do not add constraints to the type of `value` to bring more flexibility to developers. However, it is the responsibility of developers to ensure that the data is clear and well-organized. We also do not provide advanced operations such as "list keys" or "clear," so it is strongly recommended to reuse keys when possible.
126-
:::
127-
128103
`userInfoEndpoint` is the endpoint which is used to get user information.
129104

130105
You may check official documents to find specific user information that can be accessed at user info endpoint and corresponding scope.

β€Žversioned_docs/version-1.x/docs/recipes/customize-sie/README.mdβ€Ž

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,18 @@ Logto covers the tedious part, so you can have fun with customization to define
1414

1515
In Admin Console, click the "Sign-in Experience" tab on the left, and you'll see a two-column page.
1616

17-
The left column is the customization section with three tabs: Branding, Sign-in Methods, and Others.
17+
The left column is the customization section with three tabs: **Branding**, **Sign-in and sign-up**, and **Others**.
18+
19+
1. Configure sign-in methods: Whether you prefer **password-based or passwordless sign-in/sign-up** options, you can easily configure them straight out of the box or customize them to align with your company's unique requirements.
20+
2. Match your brand: Quickly customize the sign-in page to match your product brand with options to set your **brand color**, **logo**, **favicon**, and **dark mode** usage.
21+
3. Custom CSS: Tailor the UI of all pages with **Custom CSS**. The orderly and concise design system of styles and components makes customization a breeze.
22+
4. Terms & Policy: Link your website's **Terms of Use** and **Privacy Policy** to the sign-in page. Users will be prompted to agree to these policies when they register.
23+
5. Language (i18n): Create a localized experience by selecting your language mode to **enable auto-detect** or **choose a default language**. Edit **i18n translations** for tailored content.
1824

1925
The right column is a live preview that will immediately update to synchronize the change when you update things on the left.
2026

27+
![Sign-in Experience homepage](./assets/sie-set-homepage.png)
28+
2129
:::tip Use preview to save your time
2230

2331
- Click the tab "Mobile" or "Web" to see what the homepage looks like on different platforms.
140 KB
Loading
91.4 KB
Loading
121 KB
Loading
37 KB
Loading
66.4 KB
Loading
104 KB
Loading

0 commit comments

Comments
Β (0)