Skip to content

Commit c5ddf56

Browse files
feat: restructure docs navigation (#2045)
* feat: new horizontal nav (#2018) * feat: new docs nav * fix: add start page to navbar * fix: add homepages to horizontal nav items * feat: vertical nav (#2020) * feat: vertical nav for quickstart * feat: vertical nav for identity * chore: credentials structure * chore: update identity sidebar structure for session management and identity actions * feat: restructure OAuth2 sidebar for improved navigation and updated links * feat: enhance permissions sidebar structure * feat: update navigation links for OAuth2 and Permissions documentation * chore: deprioritize selfhosting sidebar * chore: feedback updates or restructure * fix: remove home link from home page * fix: Make oauth2 actions apparent * feat: dropdown menus in horizontal nav (#2042) * feat: horizontal dropdown nav * feat: horizontal dropdown nav * chore: use Ory official product names * chore: relocate operations docs from API to Platform * chore: remove old sidebar (#2044) * chore: remove old sidebar * chore: remove home link from start sidebar * fix: redirects and broken links
1 parent dcd80e5 commit c5ddf56

File tree

6 files changed

+585
-705
lines changed

6 files changed

+585
-705
lines changed

docs/guides/authentication.mdx

-11
This file was deleted.

docs/quickstart/sdks.mdx

-11
This file was deleted.

docusaurus.config.ts

+6-84
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import type * as Preset from "@docusaurus/preset-classic"
66

77
import lightTheme from "./src/utils/prismLight.mjs"
88
import darkTheme from "./src/utils/prismDark.mjs"
9-
9+
import { navbar } from "./src/navbar"
1010
const config: Config = {
1111
customFields: {
1212
CLOUD_URL: process.env.CLOUD_URL || "https://api.console.ory:8080",
@@ -86,85 +86,7 @@ const config: Config = {
8686
indexName: "ory",
8787
contextualSearch: true,
8888
},
89-
navbar: {
90-
hideOnScroll: false,
91-
logo: {
92-
alt: "Ory",
93-
src: `/docs/img/logos/logo-docs-2023-02-15.svg`,
94-
srcDark: `/docs/img/logos/logo-docs-dark-2023-02-15.svg`,
95-
href: `https://www.ory.sh`,
96-
width: 63,
97-
height: 32,
98-
},
99-
items: [
100-
{
101-
type: "docSidebar",
102-
position: "left",
103-
sidebarId: "docs",
104-
label: "Documentation",
105-
},
106-
{
107-
type: "docSidebar",
108-
position: "left",
109-
sidebarId: "quickstarts-and-tutorials",
110-
label: "Quickstart",
111-
},
112-
{
113-
type: "docSidebar",
114-
position: "left",
115-
sidebarId: "guides",
116-
label: "Guides",
117-
},
118-
{
119-
type: "docSidebar",
120-
position: "left",
121-
sidebarId: "reference",
122-
label: "Reference",
123-
},
124-
{
125-
type: "docSidebar",
126-
position: "left",
127-
sidebarId: "selfhosting",
128-
label: "Self-hosting",
129-
},
130-
{
131-
label: "Need Support?",
132-
position: "right",
133-
items: [
134-
{
135-
to: "https://www.ory.sh/support",
136-
label: "Enterprise Support",
137-
},
138-
{
139-
to: "https://www.ory.sh/docs/search",
140-
label: "Search the docs",
141-
},
142-
{
143-
to: "https://www.ory.sh/chat",
144-
label: "Ory Community Slack",
145-
},
146-
{
147-
to: "https://github.com/orgs/ory/discussions",
148-
label: "GitHub Discussions",
149-
},
150-
{
151-
to: "https://stackoverflow.com/questions/tagged/ory",
152-
label: "Stack Overflow",
153-
},
154-
{
155-
to: "https://www.ory.sh/contact",
156-
label: "Schedule a discovery call",
157-
},
158-
],
159-
},
160-
161-
{
162-
href: `https://github.com/ory`,
163-
label: "GitHub",
164-
position: "right",
165-
},
166-
],
167-
},
89+
navbar,
16890
footer: {
16991
style: "dark",
17092
copyright: `Copyright © ${new Date().getFullYear()} Ory Corp`,
@@ -243,10 +165,10 @@ const config: Config = {
243165
"@docusaurus/plugin-client-redirects",
244166
{
245167
redirects: [
246-
// {
247-
// from: ['/','/docs','/docs/'],
248-
// to: '/docs/welcome'
249-
// }
168+
{
169+
from: "/quickstart/sdks",
170+
to: "/sdk",
171+
},
250172
],
251173
},
252174
],

src/navbar.ts

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
import { Navbar } from "@docusaurus/theme-common"
2+
3+
export const navbar: Navbar = {
4+
hideOnScroll: false,
5+
logo: {
6+
alt: "Ory",
7+
src: `/docs/img/logos/logo-docs-2023-02-15.svg`,
8+
srcDark: `/docs/img/logos/logo-docs-dark-2023-02-15.svg`,
9+
href: `https://www.ory.sh`,
10+
width: 63,
11+
height: 32,
12+
},
13+
items: [
14+
{
15+
to: "/getting-started/overview",
16+
label: "Start",
17+
position: "left",
18+
},
19+
{
20+
label: "Products",
21+
position: "left",
22+
items: [
23+
{
24+
to: "/docs/identities",
25+
label: "Identities",
26+
},
27+
{
28+
to: "/docs/getting-started/ory-network-oauth2",
29+
// to: "/docs/federation", // TODO: Use this route
30+
label: "OAuth2/OIDC",
31+
},
32+
{
33+
to: "/docs/guides/permissions/overview",
34+
// to: "/docs/permissions", // TODO: Use this route
35+
label: "Permissions",
36+
},
37+
],
38+
},
39+
{
40+
label: "Develop",
41+
position: "left",
42+
items: [
43+
{
44+
to: "/docs/getting-started/local-development",
45+
label: "Local Development",
46+
},
47+
{
48+
to: "/docs/ecosystem/projects",
49+
label: "Self-Hosting",
50+
},
51+
],
52+
},
53+
{
54+
label: "Manage",
55+
position: "left",
56+
items: [
57+
{
58+
to: "/docs/guides/operations",
59+
label: "Platform",
60+
},
61+
{
62+
to: "/docs/category/troubleshooting",
63+
label: "Troubleshooting",
64+
},
65+
],
66+
},
67+
{
68+
// to: "/docs/reference/api",
69+
// to: "/docs/reference", // TODO: Use this route
70+
label: "Reference",
71+
position: "left",
72+
items: [
73+
{
74+
to: "/docs/reference/api",
75+
label: "REST API",
76+
},
77+
{
78+
to: "/docs/category/ory-cli-reference",
79+
label: "Ory CLI",
80+
},
81+
{
82+
to: "/docs/sdk",
83+
label: "Ory SDKs",
84+
},
85+
],
86+
},
87+
{
88+
label: "Need Support?",
89+
position: "right",
90+
items: [
91+
{
92+
to: "https://www.ory.sh/support",
93+
label: "Enterprise Support",
94+
},
95+
{
96+
to: "https://www.ory.sh/docs/search",
97+
label: "Search the docs",
98+
},
99+
{
100+
to: "https://www.ory.sh/chat",
101+
label: "Ory Community Slack",
102+
},
103+
{
104+
to: "https://github.com/orgs/ory/discussions",
105+
label: "GitHub Discussions",
106+
},
107+
{
108+
to: "https://stackoverflow.com/questions/tagged/ory",
109+
label: "Stack Overflow",
110+
},
111+
{
112+
to: "https://www.ory.sh/contact",
113+
label: "Schedule a discovery call",
114+
},
115+
],
116+
},
117+
118+
{
119+
href: `https://github.com/ory`,
120+
label: "GitHub",
121+
position: "right",
122+
},
123+
],
124+
}

0 commit comments

Comments
 (0)