mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
fixed small docs problems
This commit is contained in:
parent
2b26e3cb44
commit
74a7db35ed
@ -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(
|
||||
|
||||
@ -1,34 +0,0 @@
|
||||
---
|
||||
subtitle: These pages will guide you through our core concepts so you can start developing with Stack, today.
|
||||
---
|
||||
|
||||
<CardGroup>
|
||||
<Card
|
||||
title="Set Up Stack"
|
||||
icon="fa-regular fa-play"
|
||||
href="/docs/get-started/set-up"
|
||||
>
|
||||
Getting started with Stack's API
|
||||
</Card>
|
||||
<Card
|
||||
title="Tutorials"
|
||||
icon="fa-regular fa-file-lines"
|
||||
href="/docs/sdks/theming"
|
||||
>
|
||||
Using Stack in your organization
|
||||
</Card>
|
||||
<Card
|
||||
title="SDKs"
|
||||
icon="fa-regular fa-file-lines"
|
||||
href="/docs/sdks/theming"
|
||||
>
|
||||
Using Stack's SDKs
|
||||
</Card>
|
||||
<Card
|
||||
title="API Reference"
|
||||
icon="fa-solid fa-code"
|
||||
href="/reference"
|
||||
>
|
||||
Using the Stack API endpoints
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
slug: user
|
||||
slug: sdk/user
|
||||
---
|
||||
|
||||
## `CurrentUser` and `CurrentServerUser`
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
slug: stack-app
|
||||
slug: sdk/stack-app
|
||||
---
|
||||
|
||||
## `StackServerApp` and `StackClientApp`
|
||||
|
||||
@ -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`.
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user