Skip to content
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

feat: vertical nav for quickstart and identity #2020

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: vertical nav for quickstart and identity #2020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1333db4
feat: vertical nav for quickstart
christiannwamba Feb 10, 2025
7693350
feat: vertical nav for identity
christiannwamba Feb 12, 2025
849f91f
Merge branch 'identity-vertical-nav' into quickstart-vertical-nav
christiannwamba Feb 12, 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
11 changes: 0 additions & 11 deletions docs/quickstart/sdks.mdx
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,10 @@ const config: Config = {
"@docusaurus/plugin-client-redirects",
{
redirects: [
// {
// from: ['/','/docs','/docs/'],
// to: '/docs/welcome'
// }
{
from: "/quickstart/sdks",
to: "/sdk",
},
],
},
],
Expand Down
193 changes: 79 additions & 114 deletions src/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,16 +85,10 @@ const referenceSidebar: ExtendSidebar = [
]

const quickstartSidebar = (flat: boolean): ExtendSidebar => {
const items = []
if (!flat) {
items.push(homeLink)
}

return [
...items,
{
type: "category",
label: "User authentication",
label: "Start",
collapsed: false,
collapsible: false,
link: {
Expand All @@ -115,64 +109,6 @@ const quickstartSidebar = (flat: boolean): ExtendSidebar => {
"getting-started/integrate-auth/dotnet",
],
},
{
type: "category",
label: "Permissions and relationships",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "guides/permissions/overview",
},
items: flat
? []
: ["keto/examples/olymp-file-sharing", "keto/guides/rbac"],
},
{
type: "category",
label: "OAuth2 and OpenID",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "guides/oauth2-openid-connect",
},
items: flat
? []
: [
"getting-started/ory-network-oauth2",
"getting-started/oauth2-openid/expressjs",
],
},
{
type: "category",
label: "Software Development Kits",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "quickstart/sdks",
},
items: flat
? []
: [
{
type: "category",
label: "Identity Management",
items: ["kratos/sdk/go"],
},
{
type: "category",
label: "OAuth2 & OpenID Connect",
items: ["hydra/sdk/js", "hydra/sdk/go"],
},
{
type: "category",
label: "Permissions",
items: ["keto/sdk/go", "keto/sdk/python"],
},
],
},
]
}
const guidesSidebar = (flat: boolean): ExtendSidebar => {
Expand Down Expand Up @@ -203,6 +139,10 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => {
{
type: "category",
label: "OpenID Connect SSO",
link: {
type: "doc",
id: "guides/oauth2-openid-connect",
},
items: [
"kratos/social-signin/overview",
{
Expand Down Expand Up @@ -486,7 +426,7 @@ const troubleshootingSidebar = [
]

const identitiesSidebar = [
homeLink,
// homeLink,
{
type: "category",
label: "Concepts",
Expand All @@ -500,68 +440,93 @@ const identitiesSidebar = [
"security-model",
"identities/native-browser",
"concepts/redirects",
{
type: "category",
label: "User flows",
link: {
type: "doc",
id: "kratos/self-service",
},
items: [
"kratos/concepts/browser-redirect-flow-completion",
"kratos/self-service/flows/user-registration",
"kratos/self-service/flows/user-login",
"kratos/self-service/flows/user-logout",
"kratos/self-service/flows/user-settings",
"kratos/self-service/flows/verify-email-account-activation",
"kratos/self-service/flows/account-recovery-password-reset",
"kratos/self-service/flows/user-facing-errors",
],
},
],
},
{
type: "category",
label: "Self-service user flows",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "kratos/self-service",
},
items: [
"kratos/concepts/browser-redirect-flow-completion",
"kratos/self-service/flows/user-registration",
"kratos/self-service/flows/user-login",
"kratos/self-service/flows/user-logout",
"kratos/self-service/flows/user-settings",
"kratos/self-service/flows/verify-email-account-activation",
"kratos/self-service/flows/account-recovery-password-reset",
"kratos/self-service/flows/user-facing-errors",
],
},
{
type: "category",
label: "Authentication",
label: "Guides",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "kratos/concepts/credentials",
},
items: [
"concepts/password-policy",
"kratos/passwordless/passwordless",
"kratos/mfa/overview",
"getting-started/local-development",
{
type: "category",
label: "Authenctication",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
label: "Authenctication",
label: "Authentication",

items: [
"getting-started/local-development",
"kratos/concepts/credentials/username-email-password",
"kratos/passwordless/passkeys",
"kratos/passwordless/one-time-code",
"kratos/organizations/organizations",
"kratos/emails-sms/custom-email-templates",
Copy link
Member

Choose a reason for hiding this comment

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

the custom email templates doc is different than the others in this category - maybe it makes sense for emails/communication to have their own category? or move it to the "configuration" category?

],
},
{
type: "category",
label: "Multi-factor authentication",
link: {
type: "doc",
id: "kratos/mfa/overview",
},
items: [
"kratos/mfa/lookup-secrets",
"kratos/mfa/totp",
"kratos/mfa/webauthn-fido-yubikey",
"kratos/mfa/mfa-via-sms",
"kratos/mfa/step-up-authentication",
],
},
{
type: "category",
label: "Credentials",
Copy link
Member

Choose a reason for hiding this comment

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

wouldn't the other auth methods like password, passkeys etc. also fall under credentials?
not sure what I would except in this category

link: {
type: "doc",
id: "kratos/concepts/credentials",
},
items: ["concepts/password-policy", "kratos/passwordless/passwordless"],
},
{
type: "category",
label: "User interface",
link: {
type: "doc",
id: "kratos/bring-your-own-ui/custom-ui-overview",
},
items: [
"account-experience/index",
"kratos/bring-your-own-ui/configure-ory-to-use-your-ui",
],
},
],
},
{
type: "category",
label: "User interface",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "kratos/bring-your-own-ui/custom-ui-overview",
},
label: "Configuration",
items: [
"account-experience/index",
"kratos/bring-your-own-ui/configure-ory-to-use-your-ui",
"identities/sign-in/two-step-registration",
"identities/sign-in/identifier-first-authentication",
"identities/sign-in/login-hint",
"identities/sign-in/actions",
],
},
{
type: "category",
label: "Send Emails & SMS",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "kratos/emails-sms/custom-email-templates",
},
items: ["kratos/emails-sms/custom-email-templates"],
},
]

const oauth2Sidebar = [
Expand Down
Loading