Skip to content

feat: new docs design#2505

Open
wassimoo wants to merge 228 commits intomasterfrom
una-redesign-imp2
Open

feat: new docs design#2505
wassimoo wants to merge 228 commits intomasterfrom
una-redesign-imp2

Conversation

@wassimoo
Copy link
Copy Markdown
Contributor

@wassimoo wassimoo commented Apr 10, 2026

Preview link: https://docs-7qgoc8ot0-ory.vercel.app/docs/welcome

Summary

This PR delivers a significant redesign of the Ory documentation site, introducing a new Homepage navigation experience, a new Quick Start page, restructured content architecture, and visual design improvements. It also establishes the foundational framework for separating documentation by deployment model: Ory Network, Ory OEL, and Ory OSS.

Changes

Homepage navigation

Replaced the previous homepage with a guided navigation experience that helps technical evaluators and developers orient quickly and find the right entry point for their use case. (Aligns better with our marketing site.)

Quick Start page

Added a new Quick Start page as a dedicated onboarding path for developers getting started with Ory for the first time.

Content restructuring

Reorganized existing documentation to support clearer content hierarchy. This restructuring is a prerequisite for the deployment-model separation work.

Product overview

Added new high-level product explanations with visual elements to demonstrate how each product fits within the context of an IAM system.

Visual design enhancements

Updated layout, typography, and component styling throughout the portal for improved readability and consistency. Introduced product color association.

Deployment model framework

Introduced the structural scaffolding to separate documentation by deployment context — Ory Network, Ory OEL, and Ory OSS — enabling product-specific content targeting in follow-on PRs.

What's not included

Full content separation by deployment model is out of scope for this PR. This change puts the framework in place; content migration and product-specific pages will follow.
Complete alignment on product names is out of the scope of this PR.

TESTING

New feature documentation (last few months)

Verify your new content appears in the redesigned navigation (docs/sidebar.ts). If it doesn't appear, add it to the /docs/sidebar.ts.

NOTE: There are several new sidebar files located within the /docs folder; if your content was added to the previous sidebar.ts file located in /src that file is no longer in use.

Content is complete

Verify that your product area contains the expected full set of content. The restructure may have affected navigation visibility for some pages.

Broken links

Spot-check links in your product area. Internal navigation files were significantly changed in this redesign.

Checklist

  • [ X] I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • [X ] I have read the security policy.
  • [X ] I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

@wassimoo wassimoo changed the title Una redesign imp2 New docs design Apr 10, 2026
@wassimoo wassimoo changed the title New docs design feat: new docs design Apr 10, 2026

## [Password-based](/docs/kratos/concepts/credentials/username-email-password)

Email/Username + Password: Traditional login using a password combined with an email address or username. [Configure password
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The [Configure password login] seems to be incomplete, should there be a url target?

There's a couple below as well:

  • [Enable passkeys]
  • [One-time code auth]
  • [Social sign-in]
  • [Enterprise SSO]
  • [Login flows]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is not actually hooked up to the sidebar and is not being used. I will delete this file.

@@ -0,0 +1,12 @@
---
id: intro
title: Introduction to Ory Kratos—Indentity & AuthN
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Indentity" typo

"permanent": false
},
{
"source": "/docs/hydra/benchmark",
"destination": "https://www.ory.com/docs/ecosystem/benchmark",
"destination": "https://www.ory.com/docs/docs/oauth2-oidc",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This destination takes user to a 404 page, I believe due to the double /docs/docs path

"permanent": true
},
{
"source": "/docs/open-source",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a duplicate of this in line 1301

"permanent": true
},
{
"source": "/docs/open-source/guidelines/rest-api-guidelines",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a duplicate of this on line 1306

"permanent": true
},
{
"source": "/docs/ecosystem/changelog",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a duplicate of this on line 1291

"permanent": true
},
{
"source": "/docs/guides/workspaces",
Copy link
Copy Markdown
Collaborator

@jaygiang jaygiang Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From line 1316-1354, it directs the user to 404 page. I believe these destination paths docs/network/ have no corresponding files. There are 8 of these

@@ -1220,17 +1220,262 @@
{
"source": "/docs/getting-started/integrate-auth/nextjs",
"destination": "/docs/getting-started/integrate-auth/nextjs-app-router-quickstart",
"permanent": true
"permanent": false
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This got changed to false, just checking if this was intentional. Same for line 1228

@@ -0,0 +1,109 @@
// Copyright © 2022 Ory Corp
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This plugin doesn't seem to be used anywhere. Can we double check?

@@ -0,0 +1,12 @@
---
id: intro
title: Introduction to Ory Kratos—Indentity & AuthN
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Introduction to Ory Kratos—Indentity & AuthN
title: Introduction to Ory Kratos—Identity & AuthN

"permanent": false
},
{
"source": "/docs/hydra/benchmark",
"destination": "https://www.ory.com/docs/ecosystem/benchmark",
"destination": "https://www.ory.com/docs/docs/oauth2-oidc",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"destination": "https://www.ory.com/docs/docs/oauth2-oidc",
"destination": "https://www.ory.com/docs/oauth2-oidc",

"destination": "/docs/oss/configuring",
"permanent": true
},
{
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{

"permanent": true
},
{
"source": "/docs/open-source",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"source": "/docs/open-source",

},
{
"source": "/docs/open-source",
"destination": "/docs/oss/open-source",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"destination": "/docs/oss/open-source",

{
"source": "/docs/open-source",
"destination": "/docs/oss/open-source",
"permanent": true
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"permanent": true

"source": "/docs/open-source",
"destination": "/docs/oss/open-source",
"permanent": true
},
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
},

{
to: "/docs/ecosystem/projects",
label: "Open Source",
label: "Change Log",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
label: "Change Log",
label: "Changelog",

Change Log looks odd to me, I think changelog is also the more common spelling (see e.g. wikipedia)

favicon: "img/favico.png",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
onBrokenLinks: "warn",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we change this back to throw? It helps us check for broken links when running build.

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.