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.

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

docs: sidebar adjustments #1898

Merged
merged 2 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/api/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: index
title: gRPC + REST API Overview
sidebar_label: API overview
sidebar_label: APIs
---

```mdx-code-block
Expand Down
1 change: 0 additions & 1 deletion docs/guides/permissions/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
id: overview
title: Get started with Permissions in the Ory Network
sidebar_label: Permissions
---

# Get started with Ory Permissions
Expand Down
3 changes: 2 additions & 1 deletion docs/hydra/sdk/05_go.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: go
title: Ory OAuth2 Go
title: Ory OAuth2 & OpenID Connect Go SDK
sidebar_label: Go SDK
---

```mdx-code-block
Expand Down
3 changes: 2 additions & 1 deletion docs/hydra/sdk/10_js.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: js
title: Ory OAuth2 JavaScript
title: Ory OAuth2 & OpenID Connect JavaScript SDK
sidebar_label: JavaScript SDK
---

In this document you can find code examples for the Ory OAuth2 JavaScript SDK.
Expand Down
3 changes: 2 additions & 1 deletion docs/keto/sdk/05_go.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: go
title: Ory Permissions Go
title: Ory Permissions Go SDK
sidebar_label: Go SDK
---

```mdx-code-block
Expand Down
3 changes: 2 additions & 1 deletion docs/keto/sdk/10_python.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: python
title: Ory Permissions Python
title: Ory Permissions Python SDK
sidebar_label: Python SDK
---

```mdx-code-block
Expand Down
3 changes: 2 additions & 1 deletion docs/kratos/sdk/05_go.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: go
title: Ory Identities Go
title: Ory Identity Management Go SDK
sidebar_label: Go SDK
---

```mdx-code-block
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: api
hide_title: true
title: Ory REST HTTP API Documentation
sidebar_label: REST API Reference
sidebar_label: REST API
---

```mdx-code-block
Expand Down
12 changes: 5 additions & 7 deletions docs/sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
id: sdk
title: Ory SDK
sidebar_label: Ory SDK
title: Software Development Kits (SDKs) for Ory
sidebar_label: SDKs
---

The Ory SDK allows for integration with Ory services, including **Ory Identities**, **Ory Permissions**, and **Ory OAuth2**.

Before using the SDK, consult the Ory [REST](./reference/api.mdx) API documentation, which includes code samples and examples for
various programming languages.

This SDK is intended to be used with Ory Network.
For self-hosting Ory services use the respective client. Read more in the
This SDK is intended to be used with Ory Network. For self-hosting Ory services use the respective client. Read more in the
[self-hosting documentation](https://www.ory.sh/docs/ecosystem/projects) for each service under **Reference/SDK**.

## Download the SDK
Expand All @@ -37,9 +36,8 @@ Ory publishes SDKs for popular languages in their respective package repositorie
To view the source code for the generated Ory SDKs, visit the GitHub repository:
[Generated SDKs for Ory](https://github.com/ory/sdk/tree/master/clients/client)

Missing your programming language?
[Create an issue](https://github.com/ory/sdk/issues) and help the Ory team build, test, and publish the SDK for your programming
language!
Missing your programming language? [Create an issue](https://github.com/ory/sdk/issues) and help the Ory team build, test, and
publish the SDK for your programming language!

### SDK Backwards compatibility

Expand Down
81 changes: 43 additions & 38 deletions src/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ const quickstartSidebar = (flat: boolean): ExtendSidebar => {

return [
...items,
"getting-started/local-development",
{
type: "category",
label: "User authentication",
Expand All @@ -101,40 +100,36 @@ const quickstartSidebar = (flat: boolean): ExtendSidebar => {
},
{
type: "category",
label: "OAuth2 and OpenID Connect",
label: "Permissions and relationships",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "guides/oauth2-openid-connect",
id: "guides/permissions/overview",
},
items: flat
? []
: [
"getting-started/ory-network-oauth2",
"getting-started/oauth2-openid/expressjs",
],
: ["keto/examples/olymp-file-sharing", "keto/guides/rbac"],
},
{
type: "category",
label: "Permissions",
label: "OAuth2 and OpenID",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "guides/permissions/overview",
id: "guides/oauth2-openid-connect",
},
items: flat
? []
: [
"keto/examples/olymp-file-sharing",
"keto/guides/rbac",
"guides/gitops",
"getting-started/ory-network-oauth2",
"getting-started/oauth2-openid/expressjs",
],
},
{
type: "category",
label: "SDK quickstarts",
label: "Software Development Kits",
collapsed: false,
collapsible: false,
link: {
Expand All @@ -144,11 +139,21 @@ const quickstartSidebar = (flat: boolean): ExtendSidebar => {
items: flat
? []
: [
"kratos/sdk/go",
"hydra/sdk/js",
"hydra/sdk/go",
"keto/sdk/go",
"keto/sdk/python",
{
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"],
},
],
},
]
Expand All @@ -163,7 +168,7 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => {
...items,
{
type: "category",
label: "Login and registration",
label: "User authentication",
collapsed: false,
collapsible: false,
link: {
Expand All @@ -173,6 +178,7 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => {
items: flat
? []
: [
"getting-started/local-development",
"kratos/concepts/credentials/username-email-password",
"kratos/passwordless/one-time-code",
"kratos/passwordless/passkeys",
Expand Down Expand Up @@ -230,33 +236,16 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => {
},
{
type: "category",
label: "Customize user experience",
label: "Customized auth flows",
items: [
"identities/sign-in/two-step-registration",
"identities/sign-in/identifier-first-authentication",
"identities/sign-in/login-hint",
"getting-started/custom-ui",
"identities/sign-in/actions",
],
},
],
},
{
type: "category",
label: "Emails and SMS",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "guides/email-sms",
},
items: flat
? []
: [
"kratos/emails-sms/sending-emails-smtp",
"kratos/emails-sms/sending-sms",
],
},
{
type: "category",
label: "Ory Actions",
Expand Down Expand Up @@ -329,6 +318,22 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => {
"kratos/manage-identities/best-practices",
],
},
{
type: "category",
label: "Emails and SMS",
collapsed: false,
collapsible: false,
link: {
type: "doc",
id: "guides/email-sms",
},
items: flat
? []
: [
"kratos/emails-sms/sending-emails-smtp",
"kratos/emails-sms/sending-sms",
],
},
{
type: "category",
label: "Session management",
Expand All @@ -351,7 +356,7 @@ const guidesSidebar = (flat: boolean): ExtendSidebar => {
},
{
type: "category",
label: "Customized UI",
label: "Build your own UI",
collapsed: false,
collapsible: false,
link: {
Expand Down
Loading