From 74a7db35edf307d162c5222a0a3ee52e04d5da89 Mon Sep 17 00:00:00 2001 From: Zai Shi Date: Mon, 15 Jul 2024 10:07:42 -0700 Subject: [PATCH] fixed small docs problems --- apps/backend/src/lib/openapi.tsx | 2 +- docs/fern/docs/pages/overview.mdx | 34 ---------------------- docs/fern/docs/pages/sdk/current-user.mdx | 2 +- docs/fern/docs/pages/sdk/sign-in.mdx | 2 +- docs/fern/docs/pages/sdk/sign-out.mdx | 2 +- docs/fern/docs/pages/sdk/sign-up.mdx | 2 +- docs/fern/docs/pages/sdk/stack-app.mdx | 2 +- docs/fern/docs/pages/sdk/stack-handler.mdx | 2 +- docs/fern/docs/pages/sdk/use-stack-app.mdx | 2 +- docs/fern/docs/pages/sdk/use-user.mdx | 2 +- 10 files changed, 9 insertions(+), 43 deletions(-) delete mode 100644 docs/fern/docs/pages/overview.mdx diff --git a/apps/backend/src/lib/openapi.tsx b/apps/backend/src/lib/openapi.tsx index 5f2b07dc0..b4fb51550 100644 --- a/apps/backend/src/lib/openapi.tsx +++ b/apps/backend/src/lib/openapi.tsx @@ -17,7 +17,7 @@ export function parseOpenAPI(options: { version: '1.0.0', }, servers: [{ - url: 'https://app.stack-auth.com/api/v1', + url: 'https://api.stack-auth.com/api/v1', description: 'Stack REST API', }], paths: Object.fromEntries( diff --git a/docs/fern/docs/pages/overview.mdx b/docs/fern/docs/pages/overview.mdx deleted file mode 100644 index 09d10e771..000000000 --- a/docs/fern/docs/pages/overview.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -subtitle: These pages will guide you through our core concepts so you can start developing with Stack, today. ---- - - - - Getting started with Stack's API - - - Using Stack in your organization - - - Using Stack's SDKs - - - Using the Stack API endpoints - - \ No newline at end of file diff --git a/docs/fern/docs/pages/sdk/current-user.mdx b/docs/fern/docs/pages/sdk/current-user.mdx index cafe790c8..1a3196b69 100644 --- a/docs/fern/docs/pages/sdk/current-user.mdx +++ b/docs/fern/docs/pages/sdk/current-user.mdx @@ -1,5 +1,5 @@ --- -slug: user +slug: sdk/user --- ## `CurrentUser` and `CurrentServerUser` diff --git a/docs/fern/docs/pages/sdk/sign-in.mdx b/docs/fern/docs/pages/sdk/sign-in.mdx index 66b615eff..ed3d31566 100644 --- a/docs/fern/docs/pages/sdk/sign-in.mdx +++ b/docs/fern/docs/pages/sdk/sign-in.mdx @@ -1,5 +1,5 @@ --- -slug: sign-in +slug: sdk/sign-in --- The `SignIn` component is a pre-built UI element that displays all available sign-in methods as configured in the Stack dashboard. diff --git a/docs/fern/docs/pages/sdk/sign-out.mdx b/docs/fern/docs/pages/sdk/sign-out.mdx index c6dd69ffb..be320e822 100644 --- a/docs/fern/docs/pages/sdk/sign-out.mdx +++ b/docs/fern/docs/pages/sdk/sign-out.mdx @@ -1,5 +1,5 @@ --- -slug: sign-out +slug: sdk/sign-out --- The `SignOut` component automatically signs out the current user when rendered. It can serve as a dedicated sign-out page, ensuring users are signed out as soon as they navigate to it. diff --git a/docs/fern/docs/pages/sdk/sign-up.mdx b/docs/fern/docs/pages/sdk/sign-up.mdx index 5197486c8..f1b94df67 100644 --- a/docs/fern/docs/pages/sdk/sign-up.mdx +++ b/docs/fern/docs/pages/sdk/sign-up.mdx @@ -1,5 +1,5 @@ --- -slug: sign-up +slug: sdk/sign-up --- The `SignUp` component is a pre-built component that displays all the sign up methods available based on the Stack dashboard configuration. diff --git a/docs/fern/docs/pages/sdk/stack-app.mdx b/docs/fern/docs/pages/sdk/stack-app.mdx index b6a972d17..6806ac66f 100644 --- a/docs/fern/docs/pages/sdk/stack-app.mdx +++ b/docs/fern/docs/pages/sdk/stack-app.mdx @@ -1,5 +1,5 @@ --- -slug: stack-app +slug: sdk/stack-app --- ## `StackServerApp` and `StackClientApp` diff --git a/docs/fern/docs/pages/sdk/stack-handler.mdx b/docs/fern/docs/pages/sdk/stack-handler.mdx index 696196472..639b3af1a 100644 --- a/docs/fern/docs/pages/sdk/stack-handler.mdx +++ b/docs/fern/docs/pages/sdk/stack-handler.mdx @@ -1,5 +1,5 @@ --- -slug: stack-handler +slug: sdk/stack-handler --- The `StackHandler` component is designed to manage navigation for all pages under the `/handler/*` route. It serves as a wrapper component that determines which page to display based on the URL path and configurations in the `StackApp`. diff --git a/docs/fern/docs/pages/sdk/use-stack-app.mdx b/docs/fern/docs/pages/sdk/use-stack-app.mdx index 83046246d..19c996518 100644 --- a/docs/fern/docs/pages/sdk/use-stack-app.mdx +++ b/docs/fern/docs/pages/sdk/use-stack-app.mdx @@ -1,5 +1,5 @@ --- -slug: use-stack-app +slug: sdk/use-stack-app --- The `useStackApp` hook returns the `StackClientApp` object that you can use to interact with the Stack API. If you want to learn more about the `StackClientApp` object, check out the [App](./stack-app.mdx) documentation. diff --git a/docs/fern/docs/pages/sdk/use-user.mdx b/docs/fern/docs/pages/sdk/use-user.mdx index 1d1d33ed8..f64d84cd3 100644 --- a/docs/fern/docs/pages/sdk/use-user.mdx +++ b/docs/fern/docs/pages/sdk/use-user.mdx @@ -1,5 +1,5 @@ --- -slug: use-user +slug: sdk/use-user --- `useUser` is a hook that returns the user object if the user is authenticated; otherwise, it returns `null` by default. However, if you pass in `{ or: "redirect" }` or `{ or: "throw" }` as an option, it will redirect to the login page or throw an error respectively when the user is not authenticated.