Skip to content

chore: remove canonical function and references #2360

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Nov 24, 2025
Merged

chore: remove canonical function and references #2360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9098f81
docs: remove CanonicalURL section from README.md
jaygiang Nov 19, 2025
ead7dd7
refactor: remove CanonicalUrl component and its usage from documentation
jaygiang Nov 19, 2025
7698758
Merge branch 'master' into fix/remove-canonical-function-and-references
jaygiang Nov 21, 2025
4ba602a
fix: code formatting
jaygiang Nov 21, 2025
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
62 changes: 0 additions & 62 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,6 @@
- [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)
- [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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -546,61 +542,3 @@ 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

## CanonicalURL

The `CanonicalURL` component specifies the authoritative URL for a page to
search engines. Docusaurus adds trailing slashes to `index.mdx` files and files
matching their parent directory names before Vercel's trailing slash removal
takes effect. This means search engines can crawl both versions (with and
without trailing slashes). The component ensures search engines know which
version is canonical by explicitly setting a URL without a trailing slash.

### 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:

````md
---
id: your-page-id
title: Your Page Title
---

```mdx-code-block
import CanonicalURL from "@site/src/components/CanonicalUrl"

<CanonicalURL path="your/canonical/path" />

Your content here...
```
````

### 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 `<link rel="canonical"` in the HTML
4. Confirm the canonical URL exists and points to the correct path without
trailing slash

Example:

```html
<link rel="canonical" href="https://www.ory.com/docs/kratos/organizations" />
```
5 changes: 1 addition & 4 deletions docs/account-experience/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ title: Account Experience Overview
sidebar_label: Account Experience
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/account-experience" />
```

The Ory Account Experience is the default user interface for all self-service screens like login, registration, or consent. It can
Expand Down Expand Up @@ -123,3 +119,4 @@ override the default translations.
## Custom Domains

The Account Experience is also available under custom domains the same way it works on the slug URL.
```
8 changes: 0 additions & 8 deletions docs/api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@ title: gRPC + REST API Overview
sidebar_label: APIs
---

```mdx-code-block
import ApiTypes from './_common/api-types.mdx'
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<ApiTypes />
<CanonicalUrl path="/api" />
```

## REST API

All services at Ory provide REST APIs. Check the [REST API Reference](../reference/api.mdx) for a complete API overview.
Expand Down
6 changes: 0 additions & 6 deletions docs/elements/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ id: index
title: Ory Elements Introduction
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/elements" />
```

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"
Expand Down
6 changes: 0 additions & 6 deletions docs/elements/reference/@ory/elements-react/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: "@ory/elements-react"
sidebar_label: "@ory/elements-react"
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/elements/reference/@ory/elements-react" />
```

# @ory/elements-react

This package provides the core functionality for Ory Elements in React.
Expand Down
6 changes: 0 additions & 6 deletions docs/elements/reference/@ory/elements-react/theme/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: "@ory/elements-react/theme"
sidebar_label: "theme"
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/elements/reference/@ory/elements-react/theme" />
```

# @ory/elements-react/theme

This package provides the default theme for Ory Elements React.
Expand Down
6 changes: 0 additions & 6 deletions docs/elements/reference/@ory/nextjs/app/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: "@ory/nextjs/app"
sidebar_label: "app"
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/elements/reference/@ory/nextjs/app" />
```

# @ory/nextjs/app

## Interfaces
Expand Down
6 changes: 0 additions & 6 deletions docs/elements/reference/@ory/nextjs/middleware/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: "@ory/nextjs/middleware"
sidebar_label: "middleware"
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/elements/reference/@ory/nextjs/middleware" />
```

# @ory/nextjs/middleware

## Functions
Expand Down
6 changes: 0 additions & 6 deletions docs/elements/reference/@ory/nextjs/pages/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: "@ory/nextjs/pages"
sidebar_label: "pages"
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/elements/reference/@ory/nextjs/pages" />
```

# @ory/nextjs/pages

## Hooks
Expand Down
6 changes: 0 additions & 6 deletions docs/identities/get-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: Identity management guide - Day 1 essentials
sidebar_label: Overview
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/identities/get-started" />
```

# Identity management guide

This guide shows how to implement basic authentication flows with Ory. It covers the essential setup and implementation details
Expand Down
6 changes: 0 additions & 6 deletions docs/identities/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: Introduction to Ory Kratos Identities
sidebar_label: Introduction
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/identities" />
```

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
Expand Down
6 changes: 0 additions & 6 deletions docs/keto/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: Introduction to Ory Keto Permissions
sidebar_label: Introduction
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/keto" />
```

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
Expand Down
6 changes: 0 additions & 6 deletions docs/kratos/organizations/organizations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ id: organizations
title: Organizations
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/kratos/organizations" />
```

# Organizations for B2B Single Sign-On OIDC & SAML

```mdx-code-block
Expand Down
6 changes: 0 additions & 6 deletions docs/oathkeeper/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ id: index
title: Introduction to Ory Oathkeeper Zero Trust Proxy
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/oathkeeper" />
```

```mdx-code-block
import Help from '@site/docs/_common/need-selfhosted-support.mdx'

Expand Down
6 changes: 0 additions & 6 deletions docs/oauth2-oidc/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: Introduction to Ory Hydra OAuth2
sidebar_label: Introduction
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/oauth2-oidc" />
```

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.

Expand Down
6 changes: 0 additions & 6 deletions docs/polis/admin-portal/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ id: index
title: Get started with Admin Portal
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/polis/admin-portal" />
```

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.

Expand Down
6 changes: 0 additions & 6 deletions docs/polis/directory-sync/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ id: index
title: Directory Sync
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/polis/directory-sync" />
```

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.

Expand Down
6 changes: 0 additions & 6 deletions docs/polis/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: Introduction to Ory Polis
sidebar_label: Introduction
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/polis" />
```

# 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.
Expand Down
6 changes: 0 additions & 6 deletions docs/polis/saml-federation/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ title: SAML Federation
sidebar_label: SAML Federation
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/polis/saml-federation" />
```

# SAML Federation

SAML Federation is an enterprise feature and you need to have an enterprise license to use this feature.
Expand Down
6 changes: 0 additions & 6 deletions docs/polis/sso-flow/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ id: index
title: Single Sign-On
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/polis/sso-flow" />
```

import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"

Expand Down
6 changes: 0 additions & 6 deletions docs/polis/sso-providers/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: SAML SSO Providers
sidebar_label: SSO Providers
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/polis/sso-providers" />
```

Ory Polis supports the following SSO providers:

- [Generic SAML 2.0 Provider](./generic-saml.mdx)
Expand Down
6 changes: 0 additions & 6 deletions docs/self-hosted/oel/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ title: Introduction to Ory Enterprise License
sidebar_label: Introduction
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/self-hosted/oel" />
```

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
Expand Down
6 changes: 0 additions & 6 deletions docs/self-hosted/oel/monitoring/monitoring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@ id: monitoring
title: Monitoring
---

```mdx-code-block
import CanonicalUrl from "@site/src/components/CanonicalUrl"

<CanonicalUrl path="/self-hosted/oel/monitoring" />
```

This guide presents exemplary monitoring configuration that will work with OEL applications.

## Prerequisites
Expand Down
17 changes: 0 additions & 17 deletions src/components/CanonicalUrl/index.tsx
View file
Open in desktop

This file was deleted.

Loading