From a5855d46e45c29555b2f1593ab2788dc2e997c1e Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Sun, 21 Sep 2025 17:54:08 -0700 Subject: [PATCH 01/17] chore: disable trailing slash in Docusaurus config --- docusaurus.config.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index cbe407b24..96597506b 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -25,6 +25,7 @@ const config: Config = { format: "detect", }, staticDirectories: ["src/static"], + trailingSlash: false, themeConfig: { respectPrefersColorScheme: true, tableOfContents: { From 2f51a62ad6e399b7348e59d205bd07549d90692d Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Sun, 21 Sep 2025 17:54:59 -0700 Subject: [PATCH 02/17] chore: remove Ory Elements reference and update links in migration and OAuth2 documentation --- docs/elements/reference/index.md | 9 --------- docs/migrate-to-ory/index.mdx | 22 +++++++++++----------- docs/oauth2-oidc/index.md | 2 +- 3 files changed, 12 insertions(+), 21 deletions(-) delete mode 100644 docs/elements/reference/index.md diff --git a/docs/elements/reference/index.md b/docs/elements/reference/index.md deleted file mode 100644 index a49e32891..000000000 --- a/docs/elements/reference/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Ory Elements Reference - -## Modules - -- [@ory/elements-react](@ory/elements-react/index.md) -- [@ory/elements-react/theme](@ory/elements-react/theme/index.md) -- [@ory/nextjs/app](@ory/nextjs/app/index.md) -- [@ory/nextjs/middleware](@ory/nextjs/middleware/index.md) -- [@ory/nextjs/pages](@ory/nextjs/pages/index.md) diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index ff0e8e77d..bf4fefd05 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -31,7 +31,7 @@ Before starting the actual migration you should choose a migration strategy. :::info If you are not sure whether or not you need OAuth2 for your use case, please read the -[When to use OAuth2](../hydra/concepts/before-oauth2) documentation. +[When to use OAuth2](/docs/hydra/concepts/before-oauth2) documentation. ::: @@ -40,7 +40,7 @@ If you are not sure whether or not you need OAuth2 for your use case, please rea If you're migrating from Auth0 or any other OAuth2-based login solution, you'll want to use Ory OAuth2 together with Ory Identities. This setup allows you to keep your existing OAuth2-based flow while integrating it with Ory's identity management. This approach is ideal if you want to keep your current implementation without making significant changes. To get started, refer - to the [Ory OAuth2 quickstart guide](../getting-started/oauth2-openid/add-oauth2-openid-connect-nodejs-expressjs) which provides + to the [Ory OAuth2 quickstart guide](/docs/getting-started/oauth2-openid/add-oauth2-openid-connect-nodejs-expressjs) which provides instructions on setting up an OAuth2/OIDC flow with Ory. - **Scenario 3** - Other @@ -145,7 +145,7 @@ projects. This involves creating a new project environment where the migration w You can create a new Ory Network project using the Ory CLI. The command ory create project allows you to specify the environment of the project, the output format, the name of the project, and the workspace to use. More details about creating a project can be -found [here](../cli/ory-create-project). +found [here](/docs/cli/ory-create-project). Before migrating your production environment, perform the migration in a development or staging environment. This allows you to test and refine the process without affecting your live data or users. @@ -156,7 +156,7 @@ To match identities from your current system with the new Ory system, you can cu specific requirements. This schema defines the types of data that the system can store for users, including names, email addresses, phone numbers, and other authentication-related information. Additionally, you can specify extra metadata fields to be included in user profiles. Ory offers default presets to assist you in creating and managing identity schemas. More details about -identity schemas can be found [here](../kratos/manage-identities/identity-schema). +identity schemas can be found [here](/docs/kratos/manage-identities/identity-schema). - Do store profile data in your identity that is used across your system. This includes the usernames, email addresses, phone numbers, first names, and last names. @@ -178,7 +178,7 @@ subdomains. This setup allows both your front end and back end to access the authentication session cookies managed by Ory. To begin integrating Ory into your frontend, it's helpful to start with the -["protect a page with login" guides](../getting-started/overview) that cover the basics of developing with Ory for various +["protect a page with login" guides](/docs/getting-started/overview) that cover the basics of developing with Ory for various programming languages and frameworks, including SDK usage and essential setup steps. Ory Network has two types of user interfaces. We recommend starting with the built-in @@ -195,21 +195,21 @@ Ory Elements can be found [here](../elements/index.mdx). When the frontend makes an API call to your backend, it will include the necessary cookies. Your backend must then forward these cookies when calling the Ory API to validate the session. For example in a Go backend, you could use a -[middleware](../getting-started/integrate-auth/go#validate-and-login) to intercept API requests and validate the session by -calling Ory’s toSession() method. Ensure that the cookies received from the front end are forwarded in this call. Since backend +[middleware](/docs/getting-started/integrate-auth/go#validate-and-login) to intercept API requests and validate the session by +calling Ory's toSession() method. Ensure that the cookies received from the front end are forwarded in this call. Since backend calls to Ory’s API won’t automatically include cookies, you must manually attach the relevant cookies to these requests. This is important for the backend to be able to check the session. When using Ory to manage identities, it is best practice to store business logic in your application database and keep only authentication-relevant data in Ory. Here’s a general approach: -1. Configure [Ory Actions](../kratos/hooks/configure-hooks) to send webhooks to your server after user registration or other +1. Configure [Ory Actions](/docs/kratos/hooks/configure-hooks) to send webhooks to your server after user registration or other identity-related events. The webhook payload will include the data of the newly created identity. 1. Upon receiving the webhook, your server can create a corresponding user record in your database. This allows your system to link Ory-managed identities with your business logic. 1. Establish a connection between the Ory identity and the user record in your database by storing the `user.id` in `identity.metadata_public.id`. This ensures that subsequent API calls can easily map the Ory identity to the correct internal - user. More about metadata in the [Identity metadata & traits ](../kratos/manage-identities/managing-users-identities-metadata) + user. More about metadata in the [Identity metadata & traits ](/docs/kratos/manage-identities/managing-users-identities-metadata) documentation. 1. Now when the frontend makes API calls containing the Ory cookie or token, the backend should verify the session using the whoami API endpoint. This endpoint returns the session details, including the identity, allowing the backend to authenticate @@ -224,14 +224,14 @@ no straightforward way to export the identities and you might need to go through Export user data from your existing authentication solution or database and find out the hashing algorithm used to hash their credentials. If your passwords are not hashed, you can bypass this step, as Ory will handle password hashing automatically during the import process. Ory supports a range of hashing algorithms; if yours is supported, use the -[create identity API](../reference/api#tag/identity/operation/createIdentity) to import your users. If the hashing algorithm isn't +[create identity API](/docs/reference/api#tag/identity/operation/createIdentity) to import your users. If the hashing algorithm isn't supported or if you can't get the hashed passwords from your current authentication system, you may want to do a "graceful" migration and use the password migration hook to migrate your existing users. You can find more details in the [Import identities ](../kratos/manage-identities/25_import-user-accounts-identities.mdx) documentation. ## Import identities -You can use the [create identity API](../reference/api#tag/identity/operation/batchPatchIdentities) to bulk import identities into +You can use the [create identity API](/docs/reference/api#tag/identity/operation/batchPatchIdentities) to bulk import identities into Ory. A maximum of 2000 identities can be created in a single request. If you need to import more identities, you need to split the import into multiple requests. The endpoint accepts a JSON array of identities, each of which must have a create property that holds the identity that should be created. You can find more details in the diff --git a/docs/oauth2-oidc/index.md b/docs/oauth2-oidc/index.md index c49c43232..e75ce6780 100644 --- a/docs/oauth2-oidc/index.md +++ b/docs/oauth2-oidc/index.md @@ -85,6 +85,6 @@ Ory OAuth2 and OpenID Connect can be used for a wide range of use cases, includi ## Next steps -See [Ory Network OAuth2 quickstart guide](../getting-started/ory-network-oauth2) to learn how to set up your own OAuth2 and OpenID +See [Ory Network OAuth2 quickstart guide](/docs/getting-started/ory-network-oauth2) to learn how to set up your own OAuth2 and OpenID Connect provider in just a few minutes. The guide walks you through the process of setting up Ory OAuth2 and OpenID Connect and configuring a sample application to use the service. From a098604e2ced6c639d23c44a735487160e7d7f66 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Thu, 25 Sep 2025 23:33:41 -0700 Subject: [PATCH 03/17] chore: update Docusaurus config for troubleshooting redirects and remove troubleshooting index document --- docs/troubleshooting/index.mdx | 12 ------------ docusaurus.config.ts | 4 ++++ 2 files changed, 4 insertions(+), 12 deletions(-) delete mode 100644 docs/troubleshooting/index.mdx diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx deleted file mode 100644 index ecc4e085d..000000000 --- a/docs/troubleshooting/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: index -hide_title: true -title: Troubleshooting Index -sidebar_label: Troubleshooting ---- - -This is an index of the different troubleshooting guides. - -import DocCardList from "@theme/DocCardList" - - diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 96597506b..5e63e4608 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -180,6 +180,10 @@ const config: Config = { from: "/quickstart/sdks", to: "/sdk", }, + { + from: "/troubleshooting", + to: "/category/troubleshooting/", + }, ], }, ], From f7793213b95d3db98b64427b64acbde0e50d66fd Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Fri, 26 Sep 2025 08:50:17 -0700 Subject: [PATCH 04/17] docs: fix formatting in migrate-to-ory page --- docs/migrate-to-ory/index.mdx | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index bf4fefd05..8e54fb73b 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -40,8 +40,8 @@ If you are not sure whether or not you need OAuth2 for your use case, please rea If you're migrating from Auth0 or any other OAuth2-based login solution, you'll want to use Ory OAuth2 together with Ory Identities. This setup allows you to keep your existing OAuth2-based flow while integrating it with Ory's identity management. This approach is ideal if you want to keep your current implementation without making significant changes. To get started, refer - to the [Ory OAuth2 quickstart guide](/docs/getting-started/oauth2-openid/add-oauth2-openid-connect-nodejs-expressjs) which provides - instructions on setting up an OAuth2/OIDC flow with Ory. + to the [Ory OAuth2 quickstart guide](/docs/getting-started/oauth2-openid/add-oauth2-openid-connect-nodejs-expressjs) which + provides instructions on setting up an OAuth2/OIDC flow with Ory. - **Scenario 3** - Other @@ -209,8 +209,8 @@ authentication-relevant data in Ory. Here’s a general approach: link Ory-managed identities with your business logic. 1. Establish a connection between the Ory identity and the user record in your database by storing the `user.id` in `identity.metadata_public.id`. This ensures that subsequent API calls can easily map the Ory identity to the correct internal - user. More about metadata in the [Identity metadata & traits ](/docs/kratos/manage-identities/managing-users-identities-metadata) - documentation. + user. More about metadata in the + [Identity metadata & traits ](/docs/kratos/manage-identities/managing-users-identities-metadata) documentation. 1. Now when the frontend makes API calls containing the Ory cookie or token, the backend should verify the session using the whoami API endpoint. This endpoint returns the session details, including the identity, allowing the backend to authenticate the request and link it to the internal user record. @@ -224,17 +224,17 @@ no straightforward way to export the identities and you might need to go through Export user data from your existing authentication solution or database and find out the hashing algorithm used to hash their credentials. If your passwords are not hashed, you can bypass this step, as Ory will handle password hashing automatically during the import process. Ory supports a range of hashing algorithms; if yours is supported, use the -[create identity API](/docs/reference/api#tag/identity/operation/createIdentity) to import your users. If the hashing algorithm isn't -supported or if you can't get the hashed passwords from your current authentication system, you may want to do a "graceful" +[create identity API](/docs/reference/api#tag/identity/operation/createIdentity) to import your users. If the hashing algorithm +isn't supported or if you can't get the hashed passwords from your current authentication system, you may want to do a "graceful" migration and use the password migration hook to migrate your existing users. You can find more details in the [Import identities ](../kratos/manage-identities/25_import-user-accounts-identities.mdx) documentation. ## Import identities -You can use the [create identity API](/docs/reference/api#tag/identity/operation/batchPatchIdentities) to bulk import identities into -Ory. A maximum of 2000 identities can be created in a single request. If you need to import more identities, you need to split the -import into multiple requests. The endpoint accepts a JSON array of identities, each of which must have a create property that -holds the identity that should be created. You can find more details in the +You can use the [create identity API](/docs/reference/api#tag/identity/operation/batchPatchIdentities) to bulk import identities +into Ory. A maximum of 2000 identities can be created in a single request. If you need to import more identities, you need to +split the import into multiple requests. The endpoint accepts a JSON array of identities, each of which must have a create +property that holds the identity that should be created. You can find more details in the [Import identities ](../kratos/manage-identities/25_import-user-accounts-identities.mdx) documentation. ### Phased migration for active sessions From d61f31a86af099b4a4f21628976da3203e22f29c Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Fri, 26 Sep 2025 09:59:40 -0700 Subject: [PATCH 05/17] docs: fix formatting in oauth2-oidc --- docs/oauth2-oidc/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/oauth2-oidc/index.md b/docs/oauth2-oidc/index.md index e75ce6780..98d6ae22e 100644 --- a/docs/oauth2-oidc/index.md +++ b/docs/oauth2-oidc/index.md @@ -85,6 +85,6 @@ Ory OAuth2 and OpenID Connect can be used for a wide range of use cases, includi ## Next steps -See [Ory Network OAuth2 quickstart guide](/docs/getting-started/ory-network-oauth2) to learn how to set up your own OAuth2 and OpenID -Connect provider in just a few minutes. The guide walks you through the process of setting up Ory OAuth2 and OpenID Connect and -configuring a sample application to use the service. +See [Ory Network OAuth2 quickstart guide](/docs/getting-started/ory-network-oauth2) to learn how to set up your own OAuth2 and +OpenID Connect provider in just a few minutes. The guide walks you through the process of setting up Ory OAuth2 and OpenID Connect +and configuring a sample application to use the service. From f6f533ab09ddf2cedca0fd53c6aca36e88ff4815 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 29 Sep 2025 21:00:41 -0700 Subject: [PATCH 06/17] docs: add Ory Identities introduction and CanonicalUrl component --- docs/hydra/self-hosted/deploy-hydra-example.mdx | 2 +- docs/identities/{index.md => index.mdx} | 4 ++++ src/components/CanonicalUrl/index.tsx | 17 +++++++++++++++++ 3 files changed, 22 insertions(+), 1 deletion(-) rename docs/identities/{index.md => index.mdx} (98%) create mode 100644 src/components/CanonicalUrl/index.tsx diff --git a/docs/hydra/self-hosted/deploy-hydra-example.mdx b/docs/hydra/self-hosted/deploy-hydra-example.mdx index 3b8a68697..4828a1c12 100644 --- a/docs/hydra/self-hosted/deploy-hydra-example.mdx +++ b/docs/hydra/self-hosted/deploy-hydra-example.mdx @@ -477,4 +477,4 @@ server { - Read the [Prepare for production](./production). - Fork the [Ory Hydra Node.js UI Reference](https://github.com/ory/hydra-login-consent-node) or [build a custom UI in the language of your choice](../sdk/01_overview.md). -- [Add Identity and Account Management](../../identities/index.md) +- [Add Identity and Account Management](../../identities/index.mdx) diff --git a/docs/identities/index.md b/docs/identities/index.mdx similarity index 98% rename from docs/identities/index.md rename to docs/identities/index.mdx index 0e7ab6fca..1e85b9b58 100644 --- a/docs/identities/index.md +++ b/docs/identities/index.mdx @@ -4,6 +4,10 @@ title: Introduction to Ory Kratos Identities sidebar_label: Introduction --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + Ory Kratos Identities is an API-first identity and user management system built on top of the widely deployed open-source [Ory Kratos](https://github.com/ory/kratos) following [cloud architecture best practices](ecosystem/software-architecture-philosophy.mdx). It implements mechanisms that allow handling diff --git a/src/components/CanonicalUrl/index.tsx b/src/components/CanonicalUrl/index.tsx new file mode 100644 index 000000000..4d949887e --- /dev/null +++ b/src/components/CanonicalUrl/index.tsx @@ -0,0 +1,17 @@ +import Head from "@docusaurus/Head" +import useBaseUrl from "@docusaurus/useBaseUrl" + +interface CanonicalUrlProps { + path: string +} + +export default function CanonicalUrl({ path }: CanonicalUrlProps) { + const absoluteUrl = useBaseUrl(path, { absolute: true }) + const canonicalUrl = absoluteUrl.replace(/\/$/, "") + + return ( + + + + ) +} \ No newline at end of file From d2d89d2ac9e5673d96312c21a2907ec6dc0f1e24 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 29 Sep 2025 21:25:17 -0700 Subject: [PATCH 07/17] docs: add Ory OAuth2 introduction and Polis --- docs/kratos/social-signin/09_ory.mdx | 2 +- docs/oauth2-oidc/{index.md => index.mdx} | 4 ++++ docs/polis/index.mdx | 4 ++++ 3 files changed, 9 insertions(+), 1 deletion(-) rename docs/oauth2-oidc/{index.md => index.mdx} (98%) diff --git a/docs/kratos/social-signin/09_ory.mdx b/docs/kratos/social-signin/09_ory.mdx index 8c726a044..3942847ad 100644 --- a/docs/kratos/social-signin/09_ory.mdx +++ b/docs/kratos/social-signin/09_ory.mdx @@ -6,7 +6,7 @@ sidebar_label: Ory # Ory -This document explains how to add [Ory OAuth2](../../oauth2-oidc/index.md) as an OIDC provider to your Ory Network project. +This document explains how to add [Ory OAuth2](../../oauth2-oidc/index.mdx) as an OIDC provider to your Ory Network project. The setup we will describe here is as follows: diff --git a/docs/oauth2-oidc/index.md b/docs/oauth2-oidc/index.mdx similarity index 98% rename from docs/oauth2-oidc/index.md rename to docs/oauth2-oidc/index.mdx index c49c43232..2d0627294 100644 --- a/docs/oauth2-oidc/index.md +++ b/docs/oauth2-oidc/index.mdx @@ -4,6 +4,10 @@ title: Introduction to Ory Hydra OAuth2 sidebar_label: Introduction --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + OAuth2 is the industry-standard protocol that enables secure machine-to-machine communication and grants limited access to data and services on behalf of users. OpenID Connect, built on top of OAuth2, is required to become a social sign-in provider. diff --git a/docs/polis/index.mdx b/docs/polis/index.mdx index 07e72c86b..b856d2154 100644 --- a/docs/polis/index.mdx +++ b/docs/polis/index.mdx @@ -4,6 +4,10 @@ title: Introduction to Ory Polis sidebar_label: Introduction --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + # Introduction to Ory Polis Ory Polis - formerly known as BoxyHQ Jackson - is an Enterprise Single Sign-On (SSO) service for SAML and OIDC identity providers. From 77e922c9e69215b4a26a7dbf7e86780ab4b3c64f Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 29 Sep 2025 22:16:13 -0700 Subject: [PATCH 08/17] docs: integrate CanonicalUrl component across multiple documentation pages --- docs/account-experience/index.mdx | 6 ++++++ docs/api/index.mdx | 6 ++++++ docs/elements/index.mdx | 6 ++++++ .../elements-react/{index.md => index.mdx} | 0 .../theme/{index.md => index.mdx} | 0 .../@ory/nextjs/app/{index.md => index.mdx} | 0 .../nextjs/middleware/{index.md => index.mdx} | 0 .../@ory/nextjs/pages/{index.md => index.mdx} | 0 docs/elements/reference/index.md | 9 --------- docs/elements/reference/index.mdx | 19 +++++++++++++++++++ docs/identities/get-started/index.mdx | 6 ++++++ docs/keto/{index.md => index.mdx} | 4 ++++ docs/kratos/organizations/organizations.mdx | 4 ++++ docs/migrate-to-ory/index.mdx | 6 ++++++ docs/oathkeeper/index.mdx | 4 ++++ docs/polis/admin-portal/index.mdx | 6 ++++++ docs/polis/directory-sync/index.mdx | 6 ++++++ docs/polis/saml-federation/index.mdx | 6 ++++++ docs/polis/sso-flow/index.mdx | 6 ++++++ docs/polis/sso-providers/index.mdx | 6 ++++++ docs/self-hosted/oel/index.mdx | 6 ++++++ .../self-hosted/oel/monitoring/monitoring.mdx | 4 ++++ docs/troubleshooting/index.mdx | 4 ++++ 23 files changed, 105 insertions(+), 9 deletions(-) rename docs/elements/reference/@ory/elements-react/{index.md => index.mdx} (100%) rename docs/elements/reference/@ory/elements-react/theme/{index.md => index.mdx} (100%) rename docs/elements/reference/@ory/nextjs/app/{index.md => index.mdx} (100%) rename docs/elements/reference/@ory/nextjs/middleware/{index.md => index.mdx} (100%) rename docs/elements/reference/@ory/nextjs/pages/{index.md => index.mdx} (100%) delete mode 100644 docs/elements/reference/index.md create mode 100644 docs/elements/reference/index.mdx rename docs/keto/{index.md => index.mdx} (97%) diff --git a/docs/account-experience/index.mdx b/docs/account-experience/index.mdx index 8827e3ef2..b7694be1e 100644 --- a/docs/account-experience/index.mdx +++ b/docs/account-experience/index.mdx @@ -4,6 +4,12 @@ title: Account Experience Overview sidebar_label: Account Experience --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + 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`. diff --git a/docs/api/index.mdx b/docs/api/index.mdx index 9a0443406..4412d68fa 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -4,6 +4,12 @@ title: gRPC + REST API Overview sidebar_label: APIs --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + ```mdx-code-block import ApiTypes from './_common/api-types.mdx' diff --git a/docs/elements/index.mdx b/docs/elements/index.mdx index 8ad1988df..c8fba0cb8 100644 --- a/docs/elements/index.mdx +++ b/docs/elements/index.mdx @@ -3,6 +3,12 @@ id: index title: Ory Elements Introduction --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + import WelcomePageSection from "@site/src/components/Welcome/welcome" import { elements } from "@site/src/pages/_assets/welcome-content" import { elementsArchitectureGraph } from "@site/src/pages/_assets/ui-graphs" diff --git a/docs/elements/reference/@ory/elements-react/index.md b/docs/elements/reference/@ory/elements-react/index.mdx similarity index 100% rename from docs/elements/reference/@ory/elements-react/index.md rename to docs/elements/reference/@ory/elements-react/index.mdx diff --git a/docs/elements/reference/@ory/elements-react/theme/index.md b/docs/elements/reference/@ory/elements-react/theme/index.mdx similarity index 100% rename from docs/elements/reference/@ory/elements-react/theme/index.md rename to docs/elements/reference/@ory/elements-react/theme/index.mdx diff --git a/docs/elements/reference/@ory/nextjs/app/index.md b/docs/elements/reference/@ory/nextjs/app/index.mdx similarity index 100% rename from docs/elements/reference/@ory/nextjs/app/index.md rename to docs/elements/reference/@ory/nextjs/app/index.mdx diff --git a/docs/elements/reference/@ory/nextjs/middleware/index.md b/docs/elements/reference/@ory/nextjs/middleware/index.mdx similarity index 100% rename from docs/elements/reference/@ory/nextjs/middleware/index.md rename to docs/elements/reference/@ory/nextjs/middleware/index.mdx diff --git a/docs/elements/reference/@ory/nextjs/pages/index.md b/docs/elements/reference/@ory/nextjs/pages/index.mdx similarity index 100% rename from docs/elements/reference/@ory/nextjs/pages/index.md rename to docs/elements/reference/@ory/nextjs/pages/index.mdx diff --git a/docs/elements/reference/index.md b/docs/elements/reference/index.md deleted file mode 100644 index a49e32891..000000000 --- a/docs/elements/reference/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Ory Elements Reference - -## Modules - -- [@ory/elements-react](@ory/elements-react/index.md) -- [@ory/elements-react/theme](@ory/elements-react/theme/index.md) -- [@ory/nextjs/app](@ory/nextjs/app/index.md) -- [@ory/nextjs/middleware](@ory/nextjs/middleware/index.md) -- [@ory/nextjs/pages](@ory/nextjs/pages/index.md) diff --git a/docs/elements/reference/index.mdx b/docs/elements/reference/index.mdx new file mode 100644 index 000000000..4d766ebc0 --- /dev/null +++ b/docs/elements/reference/index.mdx @@ -0,0 +1,19 @@ +--- +id: index +title: Ory Elements Reference +sidebar_label: Reference +--- + +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +# Ory Elements Reference + +## Modules + +- [@ory/elements-react](@ory/elements-react/index.mdx) +- [@ory/elements-react/theme](@ory/elements-react/theme/index.mdx) +- [@ory/nextjs/app](@ory/nextjs/app/index.mdx) +- [@ory/nextjs/middleware](@ory/nextjs/middleware/index.mdx) +- [@ory/nextjs/pages](@ory/nextjs/pages/index.mdx) diff --git a/docs/identities/get-started/index.mdx b/docs/identities/get-started/index.mdx index a3e3eb6a3..4f8297dec 100644 --- a/docs/identities/get-started/index.mdx +++ b/docs/identities/get-started/index.mdx @@ -4,6 +4,12 @@ title: Identity management guide - Day 1 essentials sidebar_label: Overview --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + # Identity management guide This guide shows how to implement basic authentication flows with Ory. It covers the essential setup and implementation details diff --git a/docs/keto/index.md b/docs/keto/index.mdx similarity index 97% rename from docs/keto/index.md rename to docs/keto/index.mdx index 52938ca74..a50686e59 100644 --- a/docs/keto/index.md +++ b/docs/keto/index.mdx @@ -4,6 +4,10 @@ title: Introduction to Ory Keto Permissions sidebar_label: Introduction --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + Ory Permissions is a modern permission system you can use to create a complete authorization system for your application or website, no matter the size or the complexity of the ACLs (access-control lists) your use case requires. Ory Permissions, based on the open-source Ory Keto Permission Server, is the first open-source implementation of the design principles and specifications diff --git a/docs/kratos/organizations/organizations.mdx b/docs/kratos/organizations/organizations.mdx index c7cfbf9e2..ab606669b 100644 --- a/docs/kratos/organizations/organizations.mdx +++ b/docs/kratos/organizations/organizations.mdx @@ -3,6 +3,10 @@ id: organizations title: B2B SSO & SAML --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + # B2B Single Sign-On & SAML ```mdx-code-block diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index ff0e8e77d..9307d1e0c 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -5,6 +5,12 @@ sidebar_label: Migrate to Ory sidebar_position: 1 --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + This tutorial will guide you through the process of migrating your existing authentication system to Ory Identities, creating Ory Network projects, setting up identity schemas, and customizing the user interface to match your current interface. diff --git a/docs/oathkeeper/index.mdx b/docs/oathkeeper/index.mdx index bca94f02a..b52d01ea8 100644 --- a/docs/oathkeeper/index.mdx +++ b/docs/oathkeeper/index.mdx @@ -3,6 +3,10 @@ id: index title: Introduction to Ory Oathkeeper Zero Trust Proxy --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + ```mdx-code-block import Help from '@site/docs/_common/need-selfhosted-support.mdx' diff --git a/docs/polis/admin-portal/index.mdx b/docs/polis/admin-portal/index.mdx index 6d757e998..a3fcdfaef 100644 --- a/docs/polis/admin-portal/index.mdx +++ b/docs/polis/admin-portal/index.mdx @@ -3,6 +3,12 @@ id: index title: Get started with Admin Portal --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + Ory Polis comes with an Admin Portal that allows you to manage **Enterprise SSO**, **Directory Sync** and **Setup Links** products via an easy to use web interface. diff --git a/docs/polis/directory-sync/index.mdx b/docs/polis/directory-sync/index.mdx index 415bb4b0f..921a659c2 100644 --- a/docs/polis/directory-sync/index.mdx +++ b/docs/polis/directory-sync/index.mdx @@ -3,6 +3,12 @@ id: index title: Directory Sync --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + Directory sync helps organizations automate the provisioning and de-provisioning of their users. It is based on the System for Cross-domain Identity Management (SCIM) protocol. diff --git a/docs/polis/saml-federation/index.mdx b/docs/polis/saml-federation/index.mdx index 97b99f810..096e51ff6 100644 --- a/docs/polis/saml-federation/index.mdx +++ b/docs/polis/saml-federation/index.mdx @@ -3,6 +3,12 @@ title: SAML Federation sidebar_label: SAML Federation --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + # SAML Federation SAML Federation is an enterprise feature and you need to have an enterprise license to use this feature. diff --git a/docs/polis/sso-flow/index.mdx b/docs/polis/sso-flow/index.mdx index f042fdeeb..727c20ab2 100644 --- a/docs/polis/sso-flow/index.mdx +++ b/docs/polis/sso-flow/index.mdx @@ -3,6 +3,12 @@ id: index title: Single Sign-On --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + import Tabs from "@theme/Tabs" import TabItem from "@theme/TabItem" diff --git a/docs/polis/sso-providers/index.mdx b/docs/polis/sso-providers/index.mdx index 31687cb73..2daf32adb 100644 --- a/docs/polis/sso-providers/index.mdx +++ b/docs/polis/sso-providers/index.mdx @@ -4,6 +4,12 @@ title: SAML SSO Providers sidebar_label: SSO Providers --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + Ory Polis supports the following SSO providers: - [Generic SAML 2.0 Provider](./generic-saml.mdx) diff --git a/docs/self-hosted/oel/index.mdx b/docs/self-hosted/oel/index.mdx index 9f75bbc6c..3d1f6b86c 100644 --- a/docs/self-hosted/oel/index.mdx +++ b/docs/self-hosted/oel/index.mdx @@ -4,6 +4,12 @@ title: Introduction to Ory Enterprise License sidebar_label: Introduction --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + +--- + The Ory Enterprise License (OEL) is a commercial license designed for businesses and organizations that rely on Ory's open-source identity and access control software (Ory Hydra, Ory Kratos, Ory Keto, Ory Oathkeeper, and Ory Polis) in production and mission-critical environments. It grants access to enterprise-grade features, dedicated support, and builds optimized for diff --git a/docs/self-hosted/oel/monitoring/monitoring.mdx b/docs/self-hosted/oel/monitoring/monitoring.mdx index 844bc8bc0..00e0320bf 100644 --- a/docs/self-hosted/oel/monitoring/monitoring.mdx +++ b/docs/self-hosted/oel/monitoring/monitoring.mdx @@ -3,6 +3,10 @@ id: monitoring title: Monitoring --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + This guide presents exemplary monitoring configuration that will work with OEL applications. ## Prerequisites diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx index ecc4e085d..1402deb41 100644 --- a/docs/troubleshooting/index.mdx +++ b/docs/troubleshooting/index.mdx @@ -5,6 +5,10 @@ title: Troubleshooting Index sidebar_label: Troubleshooting --- +import CanonicalUrl from '@site/src/components/CanonicalUrl'; + + + This is an index of the different troubleshooting guides. import DocCardList from "@theme/DocCardList" From 04e47d9e1d751fcd13c9765e1ecede01d07b414e Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 29 Sep 2025 22:36:56 -0700 Subject: [PATCH 09/17] docs: add CanonicalUrl component to element pages --- docs/elements/reference/@ory/elements-react/index.mdx | 10 ++++++++++ .../reference/@ory/elements-react/theme/index.mdx | 10 ++++++++++ docs/elements/reference/@ory/nextjs/app/index.mdx | 10 ++++++++++ .../reference/@ory/nextjs/middleware/index.mdx | 10 ++++++++++ docs/elements/reference/@ory/nextjs/pages/index.mdx | 10 ++++++++++ 5 files changed, 50 insertions(+) diff --git a/docs/elements/reference/@ory/elements-react/index.mdx b/docs/elements/reference/@ory/elements-react/index.mdx index 79ada07e6..63f34a2a6 100644 --- a/docs/elements/reference/@ory/elements-react/index.mdx +++ b/docs/elements/reference/@ory/elements-react/index.mdx @@ -1,3 +1,13 @@ +--- +id: index +title: "@ory/elements-react" +sidebar_label: "@ory/elements-react" +--- + +import CanonicalUrl from "@site/src/components/CanonicalUrl" + + + # @ory/elements-react This package provides the core functionality for Ory Elements in React. diff --git a/docs/elements/reference/@ory/elements-react/theme/index.mdx b/docs/elements/reference/@ory/elements-react/theme/index.mdx index 46039ad02..605ad7eb9 100644 --- a/docs/elements/reference/@ory/elements-react/theme/index.mdx +++ b/docs/elements/reference/@ory/elements-react/theme/index.mdx @@ -1,3 +1,13 @@ +--- +id: index +title: "@ory/elements-react/theme" +sidebar_label: "theme" +--- + +import CanonicalUrl from "@site/src/components/CanonicalUrl" + + + # @ory/elements-react/theme This package provides the default theme for Ory Elements React. diff --git a/docs/elements/reference/@ory/nextjs/app/index.mdx b/docs/elements/reference/@ory/nextjs/app/index.mdx index 83153913f..06a4ed20f 100644 --- a/docs/elements/reference/@ory/nextjs/app/index.mdx +++ b/docs/elements/reference/@ory/nextjs/app/index.mdx @@ -1,3 +1,13 @@ +--- +id: index +title: "@ory/nextjs/app" +sidebar_label: "app" +--- + +import CanonicalUrl from "@site/src/components/CanonicalUrl" + + + # @ory/nextjs/app ## Interfaces diff --git a/docs/elements/reference/@ory/nextjs/middleware/index.mdx b/docs/elements/reference/@ory/nextjs/middleware/index.mdx index b7b31f1b1..713f1c1b7 100644 --- a/docs/elements/reference/@ory/nextjs/middleware/index.mdx +++ b/docs/elements/reference/@ory/nextjs/middleware/index.mdx @@ -1,3 +1,13 @@ +--- +id: index +title: "@ory/nextjs/middleware" +sidebar_label: "middleware" +--- + +import CanonicalUrl from "@site/src/components/CanonicalUrl" + + + # @ory/nextjs/middleware ## Functions diff --git a/docs/elements/reference/@ory/nextjs/pages/index.mdx b/docs/elements/reference/@ory/nextjs/pages/index.mdx index fe13403be..34b76f54f 100644 --- a/docs/elements/reference/@ory/nextjs/pages/index.mdx +++ b/docs/elements/reference/@ory/nextjs/pages/index.mdx @@ -1,3 +1,13 @@ +--- +id: index +title: "@ory/nextjs/pages" +sidebar_label: "pages" +--- + +import CanonicalUrl from "@site/src/components/CanonicalUrl" + + + # @ory/nextjs/pages ## Hooks From bcbd3182e2b9d9bf012ab0b47d0cb115c867f532 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 29 Sep 2025 22:39:32 -0700 Subject: [PATCH 10/17] docs: fix formatting by using double quotes --- docs/account-experience/index.mdx | 2 +- docs/api/index.mdx | 2 +- docs/elements/index.mdx | 2 +- docs/elements/reference/index.mdx | 2 +- docs/identities/get-started/index.mdx | 2 +- docs/identities/index.mdx | 2 +- docs/keto/index.mdx | 2 +- docs/kratos/organizations/organizations.mdx | 2 +- docs/migrate-to-ory/index.mdx | 2 +- docs/oathkeeper/index.mdx | 2 +- docs/oauth2-oidc/index.mdx | 2 +- docs/polis/admin-portal/index.mdx | 2 +- docs/polis/directory-sync/index.mdx | 2 +- docs/polis/index.mdx | 2 +- docs/polis/saml-federation/index.mdx | 2 +- docs/polis/sso-flow/index.mdx | 2 +- docs/polis/sso-providers/index.mdx | 2 +- docs/self-hosted/oel/index.mdx | 2 +- docs/self-hosted/oel/monitoring/monitoring.mdx | 2 +- docs/troubleshooting/index.mdx | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/account-experience/index.mdx b/docs/account-experience/index.mdx index b7694be1e..d70e45d31 100644 --- a/docs/account-experience/index.mdx +++ b/docs/account-experience/index.mdx @@ -4,7 +4,7 @@ title: Account Experience Overview sidebar_label: Account Experience --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/api/index.mdx b/docs/api/index.mdx index 4412d68fa..0173ad441 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -4,7 +4,7 @@ title: gRPC + REST API Overview sidebar_label: APIs --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/elements/index.mdx b/docs/elements/index.mdx index c8fba0cb8..093f94b1c 100644 --- a/docs/elements/index.mdx +++ b/docs/elements/index.mdx @@ -3,7 +3,7 @@ id: index title: Ory Elements Introduction --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/elements/reference/index.mdx b/docs/elements/reference/index.mdx index 4d766ebc0..c370e4729 100644 --- a/docs/elements/reference/index.mdx +++ b/docs/elements/reference/index.mdx @@ -4,7 +4,7 @@ title: Ory Elements Reference sidebar_label: Reference --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/identities/get-started/index.mdx b/docs/identities/get-started/index.mdx index 4f8297dec..fd79047ba 100644 --- a/docs/identities/get-started/index.mdx +++ b/docs/identities/get-started/index.mdx @@ -4,7 +4,7 @@ title: Identity management guide - Day 1 essentials sidebar_label: Overview --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/identities/index.mdx b/docs/identities/index.mdx index 1e85b9b58..b13113de6 100644 --- a/docs/identities/index.mdx +++ b/docs/identities/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Kratos Identities sidebar_label: Introduction --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/keto/index.mdx b/docs/keto/index.mdx index a50686e59..f91770701 100644 --- a/docs/keto/index.mdx +++ b/docs/keto/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Keto Permissions sidebar_label: Introduction --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/kratos/organizations/organizations.mdx b/docs/kratos/organizations/organizations.mdx index ab606669b..270b1a143 100644 --- a/docs/kratos/organizations/organizations.mdx +++ b/docs/kratos/organizations/organizations.mdx @@ -3,7 +3,7 @@ id: organizations title: B2B SSO & SAML --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index 9307d1e0c..f2b2d975d 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -5,7 +5,7 @@ sidebar_label: Migrate to Ory sidebar_position: 1 --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/oathkeeper/index.mdx b/docs/oathkeeper/index.mdx index b52d01ea8..1c0073ed3 100644 --- a/docs/oathkeeper/index.mdx +++ b/docs/oathkeeper/index.mdx @@ -3,7 +3,7 @@ id: index title: Introduction to Ory Oathkeeper Zero Trust Proxy --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/oauth2-oidc/index.mdx b/docs/oauth2-oidc/index.mdx index 2d0627294..a8b150bea 100644 --- a/docs/oauth2-oidc/index.mdx +++ b/docs/oauth2-oidc/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Hydra OAuth2 sidebar_label: Introduction --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/polis/admin-portal/index.mdx b/docs/polis/admin-portal/index.mdx index a3fcdfaef..372fa9b68 100644 --- a/docs/polis/admin-portal/index.mdx +++ b/docs/polis/admin-portal/index.mdx @@ -3,7 +3,7 @@ id: index title: Get started with Admin Portal --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/polis/directory-sync/index.mdx b/docs/polis/directory-sync/index.mdx index 921a659c2..50ffa9f39 100644 --- a/docs/polis/directory-sync/index.mdx +++ b/docs/polis/directory-sync/index.mdx @@ -3,7 +3,7 @@ id: index title: Directory Sync --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/polis/index.mdx b/docs/polis/index.mdx index b856d2154..af6753349 100644 --- a/docs/polis/index.mdx +++ b/docs/polis/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Polis sidebar_label: Introduction --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/polis/saml-federation/index.mdx b/docs/polis/saml-federation/index.mdx index 096e51ff6..de064cab5 100644 --- a/docs/polis/saml-federation/index.mdx +++ b/docs/polis/saml-federation/index.mdx @@ -3,7 +3,7 @@ title: SAML Federation sidebar_label: SAML Federation --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/polis/sso-flow/index.mdx b/docs/polis/sso-flow/index.mdx index 727c20ab2..4cb507fbc 100644 --- a/docs/polis/sso-flow/index.mdx +++ b/docs/polis/sso-flow/index.mdx @@ -3,7 +3,7 @@ id: index title: Single Sign-On --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/polis/sso-providers/index.mdx b/docs/polis/sso-providers/index.mdx index 2daf32adb..4646a2514 100644 --- a/docs/polis/sso-providers/index.mdx +++ b/docs/polis/sso-providers/index.mdx @@ -4,7 +4,7 @@ title: SAML SSO Providers sidebar_label: SSO Providers --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/self-hosted/oel/index.mdx b/docs/self-hosted/oel/index.mdx index 3d1f6b86c..4fe10c92d 100644 --- a/docs/self-hosted/oel/index.mdx +++ b/docs/self-hosted/oel/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Enterprise License sidebar_label: Introduction --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/self-hosted/oel/monitoring/monitoring.mdx b/docs/self-hosted/oel/monitoring/monitoring.mdx index 00e0320bf..a712089f0 100644 --- a/docs/self-hosted/oel/monitoring/monitoring.mdx +++ b/docs/self-hosted/oel/monitoring/monitoring.mdx @@ -3,7 +3,7 @@ id: monitoring title: Monitoring --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx index 1402deb41..643c9bbab 100644 --- a/docs/troubleshooting/index.mdx +++ b/docs/troubleshooting/index.mdx @@ -5,7 +5,7 @@ title: Troubleshooting Index sidebar_label: Troubleshooting --- -import CanonicalUrl from '@site/src/components/CanonicalUrl'; +import CanonicalUrl from "@site/src/components/CanonicalUrl"; From 7f486ffcb286893f9856701bce5e55e3d394c8ee Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 29 Sep 2025 22:54:45 -0700 Subject: [PATCH 11/17] docs: remove trailing semicolons from CanonicalUrl imports --- docs/account-experience/index.mdx | 2 +- docs/api/index.mdx | 2 +- docs/elements/index.mdx | 2 +- docs/elements/reference/index.mdx | 2 +- docs/identities/get-started/index.mdx | 2 +- docs/identities/index.mdx | 2 +- docs/keto/index.mdx | 2 +- docs/kratos/organizations/organizations.mdx | 2 +- docs/migrate-to-ory/index.mdx | 2 +- docs/oathkeeper/index.mdx | 2 +- docs/oauth2-oidc/index.mdx | 2 +- docs/polis/admin-portal/index.mdx | 2 +- docs/polis/directory-sync/index.mdx | 2 +- docs/polis/index.mdx | 2 +- docs/polis/saml-federation/index.mdx | 2 +- docs/polis/sso-flow/index.mdx | 2 +- docs/polis/sso-providers/index.mdx | 2 +- docs/self-hosted/oel/index.mdx | 2 +- docs/self-hosted/oel/monitoring/monitoring.mdx | 2 +- docs/troubleshooting/index.mdx | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/account-experience/index.mdx b/docs/account-experience/index.mdx index d70e45d31..99e3686ce 100644 --- a/docs/account-experience/index.mdx +++ b/docs/account-experience/index.mdx @@ -4,7 +4,7 @@ title: Account Experience Overview sidebar_label: Account Experience --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/api/index.mdx b/docs/api/index.mdx index 0173ad441..c0fba2fec 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -4,7 +4,7 @@ title: gRPC + REST API Overview sidebar_label: APIs --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/elements/index.mdx b/docs/elements/index.mdx index 093f94b1c..02d6e2796 100644 --- a/docs/elements/index.mdx +++ b/docs/elements/index.mdx @@ -3,7 +3,7 @@ id: index title: Ory Elements Introduction --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/elements/reference/index.mdx b/docs/elements/reference/index.mdx index c370e4729..e03faa2b7 100644 --- a/docs/elements/reference/index.mdx +++ b/docs/elements/reference/index.mdx @@ -4,7 +4,7 @@ title: Ory Elements Reference sidebar_label: Reference --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/identities/get-started/index.mdx b/docs/identities/get-started/index.mdx index fd79047ba..129f28519 100644 --- a/docs/identities/get-started/index.mdx +++ b/docs/identities/get-started/index.mdx @@ -4,7 +4,7 @@ title: Identity management guide - Day 1 essentials sidebar_label: Overview --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/identities/index.mdx b/docs/identities/index.mdx index b13113de6..f61a44508 100644 --- a/docs/identities/index.mdx +++ b/docs/identities/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Kratos Identities sidebar_label: Introduction --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/keto/index.mdx b/docs/keto/index.mdx index f91770701..70f46daca 100644 --- a/docs/keto/index.mdx +++ b/docs/keto/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Keto Permissions sidebar_label: Introduction --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/kratos/organizations/organizations.mdx b/docs/kratos/organizations/organizations.mdx index 270b1a143..70d262573 100644 --- a/docs/kratos/organizations/organizations.mdx +++ b/docs/kratos/organizations/organizations.mdx @@ -3,7 +3,7 @@ id: organizations title: B2B SSO & SAML --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index f2b2d975d..a6d65be9a 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -5,7 +5,7 @@ sidebar_label: Migrate to Ory sidebar_position: 1 --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/oathkeeper/index.mdx b/docs/oathkeeper/index.mdx index 1c0073ed3..01f5ca58e 100644 --- a/docs/oathkeeper/index.mdx +++ b/docs/oathkeeper/index.mdx @@ -3,7 +3,7 @@ id: index title: Introduction to Ory Oathkeeper Zero Trust Proxy --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/oauth2-oidc/index.mdx b/docs/oauth2-oidc/index.mdx index a8b150bea..03efc8499 100644 --- a/docs/oauth2-oidc/index.mdx +++ b/docs/oauth2-oidc/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Hydra OAuth2 sidebar_label: Introduction --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/polis/admin-portal/index.mdx b/docs/polis/admin-portal/index.mdx index 372fa9b68..07cfa629a 100644 --- a/docs/polis/admin-portal/index.mdx +++ b/docs/polis/admin-portal/index.mdx @@ -3,7 +3,7 @@ id: index title: Get started with Admin Portal --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/polis/directory-sync/index.mdx b/docs/polis/directory-sync/index.mdx index 50ffa9f39..7dc1afd4a 100644 --- a/docs/polis/directory-sync/index.mdx +++ b/docs/polis/directory-sync/index.mdx @@ -3,7 +3,7 @@ id: index title: Directory Sync --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/polis/index.mdx b/docs/polis/index.mdx index af6753349..5909d2810 100644 --- a/docs/polis/index.mdx +++ b/docs/polis/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Polis sidebar_label: Introduction --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/polis/saml-federation/index.mdx b/docs/polis/saml-federation/index.mdx index de064cab5..ab4fb1a6e 100644 --- a/docs/polis/saml-federation/index.mdx +++ b/docs/polis/saml-federation/index.mdx @@ -3,7 +3,7 @@ title: SAML Federation sidebar_label: SAML Federation --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/polis/sso-flow/index.mdx b/docs/polis/sso-flow/index.mdx index 4cb507fbc..2e5dc7b85 100644 --- a/docs/polis/sso-flow/index.mdx +++ b/docs/polis/sso-flow/index.mdx @@ -3,7 +3,7 @@ id: index title: Single Sign-On --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/polis/sso-providers/index.mdx b/docs/polis/sso-providers/index.mdx index 4646a2514..dce0e701c 100644 --- a/docs/polis/sso-providers/index.mdx +++ b/docs/polis/sso-providers/index.mdx @@ -4,7 +4,7 @@ title: SAML SSO Providers sidebar_label: SSO Providers --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/self-hosted/oel/index.mdx b/docs/self-hosted/oel/index.mdx index 4fe10c92d..afdc229ed 100644 --- a/docs/self-hosted/oel/index.mdx +++ b/docs/self-hosted/oel/index.mdx @@ -4,7 +4,7 @@ title: Introduction to Ory Enterprise License sidebar_label: Introduction --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/self-hosted/oel/monitoring/monitoring.mdx b/docs/self-hosted/oel/monitoring/monitoring.mdx index a712089f0..0aa9d2ef5 100644 --- a/docs/self-hosted/oel/monitoring/monitoring.mdx +++ b/docs/self-hosted/oel/monitoring/monitoring.mdx @@ -3,7 +3,7 @@ id: monitoring title: Monitoring --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx index 643c9bbab..c2b1eb2c5 100644 --- a/docs/troubleshooting/index.mdx +++ b/docs/troubleshooting/index.mdx @@ -5,7 +5,7 @@ title: Troubleshooting Index sidebar_label: Troubleshooting --- -import CanonicalUrl from "@site/src/components/CanonicalUrl"; +import CanonicalUrl from "@site/src/components/CanonicalUrl" From 235fda10c59e382fdc0d8623a0efcfa1f8858529 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 29 Sep 2025 23:01:25 -0700 Subject: [PATCH 12/17] fix: add missing newline at end of CanonicalUrl component file --- src/components/CanonicalUrl/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/CanonicalUrl/index.tsx b/src/components/CanonicalUrl/index.tsx index 4d949887e..d43ce5401 100644 --- a/src/components/CanonicalUrl/index.tsx +++ b/src/components/CanonicalUrl/index.tsx @@ -14,4 +14,4 @@ export default function CanonicalUrl({ path }: CanonicalUrlProps) { ) -} \ No newline at end of file +} From 63ce18f7abac26e57003aa99038e48d08fc710d6 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Tue, 30 Sep 2025 11:15:32 -0700 Subject: [PATCH 13/17] refactor: remove troubleshooting index and update sidebar link by removing trailing slash --- docs/troubleshooting/index.mdx | 16 ---------------- src/sidebar.ts | 11 +---------- 2 files changed, 1 insertion(+), 26 deletions(-) delete mode 100644 docs/troubleshooting/index.mdx diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx deleted file mode 100644 index c2b1eb2c5..000000000 --- a/docs/troubleshooting/index.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: index -hide_title: true -title: Troubleshooting Index -sidebar_label: Troubleshooting ---- - -import CanonicalUrl from "@site/src/components/CanonicalUrl" - - - -This is an index of the different troubleshooting guides. - -import DocCardList from "@theme/DocCardList" - - diff --git a/src/sidebar.ts b/src/sidebar.ts index 090fee643..f98e86831 100644 --- a/src/sidebar.ts +++ b/src/sidebar.ts @@ -210,7 +210,7 @@ const troubleshooting: SidebarItemsConfig = [ collapsed: false, link: { type: "generated-index", - slug: "category/troubleshooting/", + slug: "/category/troubleshooting", }, items: [ { @@ -422,15 +422,6 @@ const kratos: SidebarItemsConfig = [ "kratos/manage-identities/account-recovery", "kratos/manage-identities/export-user-accounts-identities", - { - type: "category", - label: "Search", - items: [ - "kratos/manage-identities/search/identity-search-console", - "kratos/manage-identities/search/identity-search-api", - ], - }, - { type: "category", label: "SCIM", From 812f80ce4fb7e3c3519b3f956a044cbe1dd32f47 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Wed, 1 Oct 2025 15:38:14 -0700 Subject: [PATCH 14/17] docs: add SEO components section with CanonicalURL usage guidelines --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/README.md b/README.md index 3d571925a..c8beb5aba 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,17 @@ - [Screenshots and videos](#screenshots-and-videos) - [Compressing images](#compressing-images) - [Recording and compressing videos](#recording-and-compressing-videos) + - [Ory Console](#ory-console) + - [Navigate to Ory Console Pages](#navigate-to-ory-console-pages) - [Testing](#testing) - [Formatting documentation](#formatting-documentation) - [Adding content to "Examples" page](#adding-content-to-examples-page) - [CLI and API reference - auto-generated content](#cli-and-api-reference---auto-generated-content) + - [SEO components](#seo-components) + - [CanonicalURL](#canonicalurl) + - [When to use CanonicalURL](#when-to-use-canonicalurl) + - [How to use CanonicalURL](#how-to-use-canonicalurl) + - [How to verify CanonicalURL is working](#how-to-verify-canonicalurl-is-working) @@ -540,3 +547,58 @@ The `cmd/clidoc/main.go` is the general path for all Ory projects. The command to generate the CLI docs can be found here: https://github.com/ory/x/blob/master/clidoc/generate.go#L96 + +## SEO components + +### CanonicalURL + +The `CanonicalURL` component ensures search engines know the authoritative URL for a page, even though Vercel already handles trailing slash redirects. This is important for SEO consistency. + +#### When to use CanonicalURL + +Use this component on: + +- **Any `index.mdx` file**: These files serve content at their parent path (e.g., `/api/index.mdx`) +- **Files matching parent directory names**: When a file shares its parent directory's name (e.g., `docs/kratos/organizations/organizations.mdx`) + +Common examples include: +- Index Path (`/api/index.mdx`, `/elements/index.mdx`, `/identities/index.mdx`) +- Matching parent directory names (`docs/kratos/organizations/organizations.mdx`, `docs/self-hosted/oel/monitoring/monitoring.mdx`) + +#### How to use CanonicalURL + +Add the component at the beginning of your MDX file after the front matter: + +```mdx +--- +id: your-page-id +title: Your Page Title +--- + +import CanonicalURL from '@site/src/components/CanonicalUrl' + + + +Your content here... +``` + +The component automatically: +- Generates the full canonical URL using the site's base URL +- Removes trailing slashes to ensure URL consistency +- Adds the appropriate `` tag to the page's HTML head + +This ensures search engines understand which version of the URL should be indexed and helps consolidate page authority for better SEO performance. + +#### How to verify CanonicalURL is working + +1. Open the page in your browser +2. Right-click and select "View Page Source" (not "Inspect") +3. Search for ` +``` + +If you see a trailing slash in the canonical URL or if there's no canonical tag at all, the component may not be properly implemented. From f9290e951fce808059436e9887a6f641ae766133 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Wed, 1 Oct 2025 16:10:13 -0700 Subject: [PATCH 15/17] docs: improve formatting and readability of CanonicalURL section in README --- README.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c8beb5aba..de9078745 100644 --- a/README.md +++ b/README.md @@ -552,18 +552,25 @@ https://github.com/ory/x/blob/master/clidoc/generate.go#L96 ### CanonicalURL -The `CanonicalURL` component ensures search engines know the authoritative URL for a page, even though Vercel already handles trailing slash redirects. This is important for SEO consistency. +The `CanonicalURL` component ensures search engines know the authoritative URL +for a page, even though Vercel already handles trailing slash redirects. This is +important for SEO consistency. #### When to use CanonicalURL Use this component on: -- **Any `index.mdx` file**: These files serve content at their parent path (e.g., `/api/index.mdx`) -- **Files matching parent directory names**: When a file shares its parent directory's name (e.g., `docs/kratos/organizations/organizations.mdx`) +- **Any `index.mdx` file**: These files serve content at their parent path + (e.g., `/api/index.mdx`) +- **Files matching parent directory names**: When a file shares its parent + directory's name (e.g., `docs/kratos/organizations/organizations.mdx`) Common examples include: + - Index Path (`/api/index.mdx`, `/elements/index.mdx`, `/identities/index.mdx`) -- Matching parent directory names (`docs/kratos/organizations/organizations.mdx`, `docs/self-hosted/oel/monitoring/monitoring.mdx`) +- Matching parent directory names + (`docs/kratos/organizations/organizations.mdx`, + `docs/self-hosted/oel/monitoring/monitoring.mdx`) #### How to use CanonicalURL @@ -575,7 +582,7 @@ id: your-page-id title: Your Page Title --- -import CanonicalURL from '@site/src/components/CanonicalUrl' +import CanonicalURL from "@site/src/components/CanonicalUrl" @@ -583,22 +590,27 @@ Your content here... ``` The component automatically: + - Generates the full canonical URL using the site's base URL - Removes trailing slashes to ensure URL consistency - Adds the appropriate `` tag to the page's HTML head -This ensures search engines understand which version of the URL should be indexed and helps consolidate page authority for better SEO performance. +This ensures search engines understand which version of the URL should be +indexed and helps consolidate page authority for better SEO performance. #### How to verify CanonicalURL is working 1. Open the page in your browser 2. Right-click and select "View Page Source" (not "Inspect") 3. Search for ` + ``` -If you see a trailing slash in the canonical URL or if there's no canonical tag at all, the component may not be properly implemented. +If you see a trailing slash in the canonical URL or if there's no canonical tag +at all, the component may not be properly implemented. From f848aadbde95dada8a263d2de91ceaacf44ccff0 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 6 Oct 2025 11:56:32 -0700 Subject: [PATCH 16/17] docs: remove unnecessary comment lines --- docs/account-experience/index.mdx | 2 -- docs/api/index.mdx | 2 -- docs/elements/index.mdx | 2 -- docs/identities/get-started/index.mdx | 2 -- docs/migrate-to-ory/index.mdx | 2 -- docs/polis/admin-portal/index.mdx | 2 -- docs/polis/directory-sync/index.mdx | 2 -- docs/polis/saml-federation/index.mdx | 2 -- docs/polis/sso-flow/index.mdx | 2 -- docs/polis/sso-providers/index.mdx | 2 -- docs/self-hosted/oel/index.mdx | 2 -- 11 files changed, 22 deletions(-) diff --git a/docs/account-experience/index.mdx b/docs/account-experience/index.mdx index 99e3686ce..694da9b41 100644 --- a/docs/account-experience/index.mdx +++ b/docs/account-experience/index.mdx @@ -8,8 +8,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - 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`. diff --git a/docs/api/index.mdx b/docs/api/index.mdx index c0fba2fec..f12a74d01 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -8,8 +8,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - ```mdx-code-block import ApiTypes from './_common/api-types.mdx' diff --git a/docs/elements/index.mdx b/docs/elements/index.mdx index 02d6e2796..26afb1e62 100644 --- a/docs/elements/index.mdx +++ b/docs/elements/index.mdx @@ -7,8 +7,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - import WelcomePageSection from "@site/src/components/Welcome/welcome" import { elements } from "@site/src/pages/_assets/welcome-content" import { elementsArchitectureGraph } from "@site/src/pages/_assets/ui-graphs" diff --git a/docs/identities/get-started/index.mdx b/docs/identities/get-started/index.mdx index 129f28519..034a6efd7 100644 --- a/docs/identities/get-started/index.mdx +++ b/docs/identities/get-started/index.mdx @@ -8,8 +8,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - # Identity management guide This guide shows how to implement basic authentication flows with Ory. It covers the essential setup and implementation details diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index a6d65be9a..007fa3084 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -9,8 +9,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - This tutorial will guide you through the process of migrating your existing authentication system to Ory Identities, creating Ory Network projects, setting up identity schemas, and customizing the user interface to match your current interface. diff --git a/docs/polis/admin-portal/index.mdx b/docs/polis/admin-portal/index.mdx index 07cfa629a..ac63d1730 100644 --- a/docs/polis/admin-portal/index.mdx +++ b/docs/polis/admin-portal/index.mdx @@ -7,8 +7,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - Ory Polis comes with an Admin Portal that allows you to manage **Enterprise SSO**, **Directory Sync** and **Setup Links** products via an easy to use web interface. diff --git a/docs/polis/directory-sync/index.mdx b/docs/polis/directory-sync/index.mdx index 7dc1afd4a..9bcc1da94 100644 --- a/docs/polis/directory-sync/index.mdx +++ b/docs/polis/directory-sync/index.mdx @@ -7,8 +7,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - Directory sync helps organizations automate the provisioning and de-provisioning of their users. It is based on the System for Cross-domain Identity Management (SCIM) protocol. diff --git a/docs/polis/saml-federation/index.mdx b/docs/polis/saml-federation/index.mdx index ab4fb1a6e..637990fae 100644 --- a/docs/polis/saml-federation/index.mdx +++ b/docs/polis/saml-federation/index.mdx @@ -7,8 +7,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - # SAML Federation SAML Federation is an enterprise feature and you need to have an enterprise license to use this feature. diff --git a/docs/polis/sso-flow/index.mdx b/docs/polis/sso-flow/index.mdx index 2e5dc7b85..70c1b164b 100644 --- a/docs/polis/sso-flow/index.mdx +++ b/docs/polis/sso-flow/index.mdx @@ -7,8 +7,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - import Tabs from "@theme/Tabs" import TabItem from "@theme/TabItem" diff --git a/docs/polis/sso-providers/index.mdx b/docs/polis/sso-providers/index.mdx index dce0e701c..3dce5904d 100644 --- a/docs/polis/sso-providers/index.mdx +++ b/docs/polis/sso-providers/index.mdx @@ -8,8 +8,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - Ory Polis supports the following SSO providers: - [Generic SAML 2.0 Provider](./generic-saml.mdx) diff --git a/docs/self-hosted/oel/index.mdx b/docs/self-hosted/oel/index.mdx index afdc229ed..aaf58994a 100644 --- a/docs/self-hosted/oel/index.mdx +++ b/docs/self-hosted/oel/index.mdx @@ -8,8 +8,6 @@ import CanonicalUrl from "@site/src/components/CanonicalUrl" ---- - The Ory Enterprise License (OEL) is a commercial license designed for businesses and organizations that rely on Ory's open-source identity and access control software (Ory Hydra, Ory Kratos, Ory Keto, Ory Oathkeeper, and Ory Polis) in production and mission-critical environments. It grants access to enterprise-grade features, dedicated support, and builds optimized for From 8f1ccccdb724dc26d87a1a780941046f3d8f9537 Mon Sep 17 00:00:00 2001 From: Jay Giang Date: Mon, 6 Oct 2025 12:46:40 -0700 Subject: [PATCH 17/17] docs: add mdx-code-block to all docs using CanonicalUrl --- docs/account-experience/index.mdx | 2 ++ docs/api/index.mdx | 2 ++ docs/elements/index.mdx | 2 ++ docs/elements/reference/@ory/elements-react/index.mdx | 2 ++ docs/elements/reference/@ory/elements-react/theme/index.mdx | 2 ++ docs/elements/reference/@ory/nextjs/app/index.mdx | 2 ++ docs/elements/reference/@ory/nextjs/middleware/index.mdx | 2 ++ docs/elements/reference/@ory/nextjs/pages/index.mdx | 2 ++ docs/elements/reference/index.mdx | 2 ++ docs/identities/get-started/index.mdx | 2 ++ docs/identities/index.mdx | 2 ++ docs/keto/index.mdx | 2 ++ docs/kratos/organizations/organizations.mdx | 2 ++ docs/migrate-to-ory/index.mdx | 2 ++ docs/oathkeeper/index.mdx | 2 ++ docs/oauth2-oidc/index.mdx | 2 ++ docs/polis/admin-portal/index.mdx | 2 ++ docs/polis/directory-sync/index.mdx | 2 ++ docs/polis/index.mdx | 2 ++ docs/polis/saml-federation/index.mdx | 2 ++ docs/polis/sso-flow/index.mdx | 2 ++ docs/polis/sso-providers/index.mdx | 2 ++ docs/self-hosted/oel/index.mdx | 2 ++ docs/self-hosted/oel/monitoring/monitoring.mdx | 2 ++ 24 files changed, 48 insertions(+) diff --git a/docs/account-experience/index.mdx b/docs/account-experience/index.mdx index 694da9b41..2e35e565f 100644 --- a/docs/account-experience/index.mdx +++ b/docs/account-experience/index.mdx @@ -4,9 +4,11 @@ title: Account Experience Overview sidebar_label: Account Experience --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` 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 diff --git a/docs/api/index.mdx b/docs/api/index.mdx index f12a74d01..df5178cbe 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -4,9 +4,11 @@ title: gRPC + REST API Overview sidebar_label: APIs --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` ```mdx-code-block import ApiTypes from './_common/api-types.mdx' diff --git a/docs/elements/index.mdx b/docs/elements/index.mdx index 26afb1e62..b2b1c67ac 100644 --- a/docs/elements/index.mdx +++ b/docs/elements/index.mdx @@ -3,9 +3,11 @@ id: index title: Ory Elements Introduction --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` import WelcomePageSection from "@site/src/components/Welcome/welcome" import { elements } from "@site/src/pages/_assets/welcome-content" diff --git a/docs/elements/reference/@ory/elements-react/index.mdx b/docs/elements/reference/@ory/elements-react/index.mdx index 63f34a2a6..8c52069bc 100644 --- a/docs/elements/reference/@ory/elements-react/index.mdx +++ b/docs/elements/reference/@ory/elements-react/index.mdx @@ -4,9 +4,11 @@ title: "@ory/elements-react" sidebar_label: "@ory/elements-react" --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # @ory/elements-react diff --git a/docs/elements/reference/@ory/elements-react/theme/index.mdx b/docs/elements/reference/@ory/elements-react/theme/index.mdx index 605ad7eb9..a33b634d3 100644 --- a/docs/elements/reference/@ory/elements-react/theme/index.mdx +++ b/docs/elements/reference/@ory/elements-react/theme/index.mdx @@ -4,9 +4,11 @@ title: "@ory/elements-react/theme" sidebar_label: "theme" --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # @ory/elements-react/theme diff --git a/docs/elements/reference/@ory/nextjs/app/index.mdx b/docs/elements/reference/@ory/nextjs/app/index.mdx index 06a4ed20f..dbf3560f5 100644 --- a/docs/elements/reference/@ory/nextjs/app/index.mdx +++ b/docs/elements/reference/@ory/nextjs/app/index.mdx @@ -4,9 +4,11 @@ title: "@ory/nextjs/app" sidebar_label: "app" --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # @ory/nextjs/app diff --git a/docs/elements/reference/@ory/nextjs/middleware/index.mdx b/docs/elements/reference/@ory/nextjs/middleware/index.mdx index 713f1c1b7..109bce2b5 100644 --- a/docs/elements/reference/@ory/nextjs/middleware/index.mdx +++ b/docs/elements/reference/@ory/nextjs/middleware/index.mdx @@ -4,9 +4,11 @@ title: "@ory/nextjs/middleware" sidebar_label: "middleware" --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # @ory/nextjs/middleware diff --git a/docs/elements/reference/@ory/nextjs/pages/index.mdx b/docs/elements/reference/@ory/nextjs/pages/index.mdx index 34b76f54f..604f5f9dc 100644 --- a/docs/elements/reference/@ory/nextjs/pages/index.mdx +++ b/docs/elements/reference/@ory/nextjs/pages/index.mdx @@ -4,9 +4,11 @@ title: "@ory/nextjs/pages" sidebar_label: "pages" --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # @ory/nextjs/pages diff --git a/docs/elements/reference/index.mdx b/docs/elements/reference/index.mdx index e03faa2b7..e77a184d9 100644 --- a/docs/elements/reference/index.mdx +++ b/docs/elements/reference/index.mdx @@ -4,9 +4,11 @@ title: Ory Elements Reference sidebar_label: Reference --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # Ory Elements Reference diff --git a/docs/identities/get-started/index.mdx b/docs/identities/get-started/index.mdx index 034a6efd7..035e80691 100644 --- a/docs/identities/get-started/index.mdx +++ b/docs/identities/get-started/index.mdx @@ -4,9 +4,11 @@ title: Identity management guide - Day 1 essentials sidebar_label: Overview --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # Identity management guide diff --git a/docs/identities/index.mdx b/docs/identities/index.mdx index f61a44508..a19eef3c3 100644 --- a/docs/identities/index.mdx +++ b/docs/identities/index.mdx @@ -4,9 +4,11 @@ title: Introduction to Ory Kratos Identities sidebar_label: Introduction --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` Ory Kratos Identities is an API-first identity and user management system built on top of the widely deployed open-source [Ory Kratos](https://github.com/ory/kratos) following diff --git a/docs/keto/index.mdx b/docs/keto/index.mdx index 70f46daca..524a9072b 100644 --- a/docs/keto/index.mdx +++ b/docs/keto/index.mdx @@ -4,9 +4,11 @@ title: Introduction to Ory Keto Permissions sidebar_label: Introduction --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` Ory Permissions is a modern permission system you can use to create a complete authorization system for your application or website, no matter the size or the complexity of the ACLs (access-control lists) your use case requires. Ory Permissions, based on diff --git a/docs/kratos/organizations/organizations.mdx b/docs/kratos/organizations/organizations.mdx index 70d262573..a2f407834 100644 --- a/docs/kratos/organizations/organizations.mdx +++ b/docs/kratos/organizations/organizations.mdx @@ -3,9 +3,11 @@ id: organizations title: B2B SSO & SAML --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # B2B Single Sign-On & SAML diff --git a/docs/migrate-to-ory/index.mdx b/docs/migrate-to-ory/index.mdx index 007fa3084..b292c4fb3 100644 --- a/docs/migrate-to-ory/index.mdx +++ b/docs/migrate-to-ory/index.mdx @@ -5,9 +5,11 @@ sidebar_label: Migrate to Ory sidebar_position: 1 --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` This tutorial will guide you through the process of migrating your existing authentication system to Ory Identities, creating Ory Network projects, setting up identity schemas, and customizing the user interface to match your current interface. diff --git a/docs/oathkeeper/index.mdx b/docs/oathkeeper/index.mdx index 01f5ca58e..29c6798a1 100644 --- a/docs/oathkeeper/index.mdx +++ b/docs/oathkeeper/index.mdx @@ -3,9 +3,11 @@ id: index title: Introduction to Ory Oathkeeper Zero Trust Proxy --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` ```mdx-code-block import Help from '@site/docs/_common/need-selfhosted-support.mdx' diff --git a/docs/oauth2-oidc/index.mdx b/docs/oauth2-oidc/index.mdx index 03efc8499..a8cb333e2 100644 --- a/docs/oauth2-oidc/index.mdx +++ b/docs/oauth2-oidc/index.mdx @@ -4,9 +4,11 @@ title: Introduction to Ory Hydra OAuth2 sidebar_label: Introduction --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` OAuth2 is the industry-standard protocol that enables secure machine-to-machine communication and grants limited access to data and services on behalf of users. OpenID Connect, built on top of OAuth2, is required to become a social sign-in provider. diff --git a/docs/polis/admin-portal/index.mdx b/docs/polis/admin-portal/index.mdx index ac63d1730..33855adce 100644 --- a/docs/polis/admin-portal/index.mdx +++ b/docs/polis/admin-portal/index.mdx @@ -3,9 +3,11 @@ id: index title: Get started with Admin Portal --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` Ory Polis comes with an Admin Portal that allows you to manage **Enterprise SSO**, **Directory Sync** and **Setup Links** products via an easy to use web interface. diff --git a/docs/polis/directory-sync/index.mdx b/docs/polis/directory-sync/index.mdx index 9bcc1da94..78c1ad326 100644 --- a/docs/polis/directory-sync/index.mdx +++ b/docs/polis/directory-sync/index.mdx @@ -3,9 +3,11 @@ id: index title: Directory Sync --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` Directory sync helps organizations automate the provisioning and de-provisioning of their users. It is based on the System for Cross-domain Identity Management (SCIM) protocol. diff --git a/docs/polis/index.mdx b/docs/polis/index.mdx index 5909d2810..e4b48feaa 100644 --- a/docs/polis/index.mdx +++ b/docs/polis/index.mdx @@ -4,9 +4,11 @@ title: Introduction to Ory Polis sidebar_label: Introduction --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # Introduction to Ory Polis diff --git a/docs/polis/saml-federation/index.mdx b/docs/polis/saml-federation/index.mdx index 637990fae..7ab05b4d8 100644 --- a/docs/polis/saml-federation/index.mdx +++ b/docs/polis/saml-federation/index.mdx @@ -3,9 +3,11 @@ title: SAML Federation sidebar_label: SAML Federation --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` # SAML Federation diff --git a/docs/polis/sso-flow/index.mdx b/docs/polis/sso-flow/index.mdx index 70c1b164b..0598dcd9e 100644 --- a/docs/polis/sso-flow/index.mdx +++ b/docs/polis/sso-flow/index.mdx @@ -3,9 +3,11 @@ id: index title: Single Sign-On --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` import Tabs from "@theme/Tabs" import TabItem from "@theme/TabItem" diff --git a/docs/polis/sso-providers/index.mdx b/docs/polis/sso-providers/index.mdx index 3dce5904d..c0967977c 100644 --- a/docs/polis/sso-providers/index.mdx +++ b/docs/polis/sso-providers/index.mdx @@ -4,9 +4,11 @@ title: SAML SSO Providers sidebar_label: SSO Providers --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` Ory Polis supports the following SSO providers: diff --git a/docs/self-hosted/oel/index.mdx b/docs/self-hosted/oel/index.mdx index aaf58994a..e11c52c2a 100644 --- a/docs/self-hosted/oel/index.mdx +++ b/docs/self-hosted/oel/index.mdx @@ -4,9 +4,11 @@ title: Introduction to Ory Enterprise License sidebar_label: Introduction --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` The Ory Enterprise License (OEL) is a commercial license designed for businesses and organizations that rely on Ory's open-source identity and access control software (Ory Hydra, Ory Kratos, Ory Keto, Ory Oathkeeper, and Ory Polis) in production and diff --git a/docs/self-hosted/oel/monitoring/monitoring.mdx b/docs/self-hosted/oel/monitoring/monitoring.mdx index 0aa9d2ef5..d2884d7ad 100644 --- a/docs/self-hosted/oel/monitoring/monitoring.mdx +++ b/docs/self-hosted/oel/monitoring/monitoring.mdx @@ -3,9 +3,11 @@ id: monitoring title: Monitoring --- +```mdx-code-block import CanonicalUrl from "@site/src/components/CanonicalUrl" +``` This guide presents exemplary monitoring configuration that will work with OEL applications.