Skip to content

feat: new docs design#2505

Merged
wassimoo merged 259 commits into
masterfrom
una-redesign-imp2
Apr 23, 2026
Merged

feat: new docs design#2505
wassimoo merged 259 commits into
masterfrom
una-redesign-imp2

Conversation

@wassimoo
Copy link
Copy Markdown
Contributor

@wassimoo wassimoo commented Apr 10, 2026

Preview link: https://docs-rfbjzxqwi-ory.vercel.app/docs

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 security@ory.com) 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).

Summary by CodeRabbit

  • New Features

    • Interactive solution‑designer with live architecture diagram; expanded Quickstarts (deployment modes, category & language filters, grids) and a new Welcome page with framework code snippets and quickstart cards.
  • Documentation

    • Added product architecture guide and OSS landing page; many documentation links updated and Quickstart/example links normalized.
  • Updates

    • Site navigation refreshed, theme and design tokens overhauled, new sidebars and updated UI/preview components.
  • Infrastructure

    • CI workflows upgraded to newer Actions and Node.js 24.

Co-authored-by: Vincent <vincent@ory.sh>
Copy link
Copy Markdown
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

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

Sitemap wise it looks like we're all covered now! Very nice! :) So from that perspective a big ✅ from my side. Results: results.csv - 404s are expected since they're on master but not on this branch yet.

There's still a bit of clean up neccessary.

Also, I think the current canonical set up is not sustainable in the medium term, and will lead to SEO issues, because all the links are manually "hardcoded", meaning that whenever a document changes URL, they need to be manually updated, and I have a high level of confidence it will be forgotten, or maybe a copy and paste error will send google to the wrong canonical.

For that reason I would suggest to have a custom component that properly sets the canonical URL and instead of hardcoding it, generates it somehow or at least is able to verify if the linked document exists.

Something like

<Canonical doc="../network/deployment.mdx" />

instead of the manually curated

<head>
  <link rel="canonical" href="https://www.ory.com/docs/network/oathkeeper" />
</head>

Regarding the canonicals, how did you verify that the canonical URLs

  1. are the correct document
  2. actually exist

?

Comment thread docs/guides/operations.mdx
Comment thread docs/hydra/self-hosted/dependencies-environment.md Outdated
Comment thread docs/hydra/self-hosted/production.md Outdated
Comment thread docs/keto/guides/production.md Outdated
Comment thread docs/keto/guides/production.md Outdated
Comment thread docs/kratos/guides/production.md Outdated
Comment thread docs/kratos/configuring.md Outdated
Comment thread docs/network/hydra/quickstarts/ory-network-oauth2.mdx
Comment thread docs/oel/kratos/quickstarts/01_overview.mdx
Comment thread docs/oss/deployment.mdx
Comment thread sidebars-oss.ts Outdated
Comment thread sidebars-oss.ts Outdated
Comment thread sidebars-oss.ts Outdated
Comment thread sidebars-oss.ts Outdated
Comment thread sidebars-oss.ts Outdated
Comment thread src/navbar.ts Outdated
@unatasha8
Copy link
Copy Markdown
Contributor

Sitemap wise it looks like we're all covered now! Very nice! :) So from that perspective a big ✅ from my side. Results: results.csv - 404s are expected since they're on master but not on this branch yet.

There's still a bit of clean up neccessary.

Also, I think the current canonical set up is not sustainable in the medium term, and will lead to SEO issues, because all the links are manually "hardcoded", meaning that whenever a document changes URL, they need to be manually updated, and I have a high level of confidence it will be forgotten, or maybe a copy and paste error will send google to the wrong canonical.

For that reason I would suggest to have a custom component that properly sets the canonical URL and instead of hardcoding it, generates it somehow or at least is able to verify if the linked document exists.

Something like

<Canonical doc="../network/deployment.mdx" />

instead of the manually curated

<head>
  <link rel="canonical" href="https://www.ory.com/docs/network/oathkeeper" />
</head>

Regarding the canonicals, how did you verify that the canonical URLs

  1. are the correct document
  2. actually exist

?

Jay and I eye-balled that they existed in the output via the Chrome > Inspect tool

@unatasha8 unatasha8 closed this Apr 22, 2026
@unatasha8 unatasha8 reopened this Apr 22, 2026
@jaygiang jaygiang dismissed their stale review April 22, 2026 17:40

Issues resolved

@wassimoo wassimoo merged commit 0e1a994 into master Apr 23, 2026
11 checks passed
@wassimoo wassimoo deleted the una-redesign-imp2 branch April 23, 2026 05:19
@unatasha8 unatasha8 restored the una-redesign-imp2 branch April 30, 2026 17:24
@wassimoo wassimoo mentioned this pull request May 13, 2026
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.