Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: initial account experience docs #1526

Merged
merged 3 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/account-experience/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: index
title: Account-Experience Overview
sidebar_label: Account-Experience
---

The Ory Account Experience is the default user interface for all self-service screens like login, registration, or consent. It can
be accessed under `https://your-slug.projects.oryapis.com/ui`. New Ory Network projects are automatically configured to use the
Account Experience. You can find various customizations and settings in the Ory Console under `Account Experience`.

## Theming

The Account Experience can be themed using the Ory Console. Head over to the
[theming settings](https://console.ory.sh/projects/current/account-experience/theming). It is also possible to set a custom logo
and favicon.

## Welcome Screen

The Account Experience comes with a welcome screen that shows information about the current user's session. As this screen is
rather meant for debugging purposes, it can be disabled in the [Ory Console](https://console.ory.sh/projects/current/ui).

## Translations (i18n) & Message Customization

Currently, the account experience is available in English (fallback), Spanish, and German. If you want to add a new language or
fix some wording, please open a pull request in [ory/elements](https://github.com/ory/elements#internalization-i18n). To determine
the language to use, the Account Experience uses the `Accept-Language` header. If the language is not available, the fallback
language (English) is used. Custom translations are not supported at the moment, but please reach out if you need this feature.

## Custom Domains

The Account Experience is also available under custom domains the same way it works on the slug URL.
9 changes: 5 additions & 4 deletions docs/kratos/bring-your-own-ui/01_overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ Network.

## Why should I use Ory Account Experience?

Ory Account Experience is the out-of-the-box UI that comes with every Ory Network project, on all available plans. It allows you
to start using Ory without the need to understand the APIs in detail. With Ory Account Experience, your UI adjusts dynamically to
reflect the changes in your project configuration, such as adding new social sign-in connectors. You can also make the look of the
Account Experience UI match your brand using the customization tools available in the Ory Console.
[Ory Account Experience](../../account-experience/index.mdx) is the out-of-the-box UI that comes with every Ory Network project,
on all available plans. It allows you to start using Ory without the need to understand the APIs in detail. With Ory Account
Experience, your UI adjusts dynamically to reflect the changes in your project configuration, such as adding new social sign-in
connectors. You can also make the look of the Account Experience UI match your brand using the customization tools available in
the Ory Console.

To see the Ory Account Experience in action and customize the views, go to the **Overview** and **Theming** views of the **Account
Experience** section in the Ory Console.
Expand Down
1 change: 1 addition & 0 deletions src/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,7 @@ module.exports = {
},
],
},
"account-experience/index",
{
type: "category",
label: "Ory CLI",
Expand Down