Skip to content

Commit a4c9dc0

Browse files
committed
docs: refine documentation and rename setup pages
- Update Aside component types in API server docs - Standardize title formatting in authentication feature doc - Rename getting-started pages to local-setup across different modules - Adjust titles and content in renamed local-setup pages
1 parent 6b863c1 commit a4c9dc0

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

src/content/docs/api-server/advanced/dependency-injection.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ When the server first starts, the `init()` method on this singleton is called. I
1919
4. **Initializes Repositories:** Wraps each data client in a `DataRepository`. Repositories provide a clean abstraction layer over the data clients.
2020
5. **Initializes Services:** Creates instances of all core business logic services (e.g., `AuthService`, `DashboardSummaryService`), injecting the repositories and other services they depend on.
2121

22-
<Aside type="info">
22+
<Aside type="note">
2323
This centralized initialization ensures that all dependencies are ready before the server begins accepting requests and that the dependency graph is correctly resolved.
2424
</Aside>
2525

src/content/docs/api-server/features/authentication.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Feature: Authentication
2+
title: 'Feature: Authentication'
33
description: A deep dive into the API server's authentication flows, including passwordless sign-in, guest accounts, and token management.
44
---
55

@@ -16,7 +16,7 @@ Instead of traditional passwords, the system uses a secure one-time code sent to
1616
- **Requesting a Code (`/api/v1/auth/request-code`):** The client sends the user's email to this endpoint. The server generates a 6-digit code, stores it temporarily, and emails it to the user.
1717
- **Verifying a Code (`/api/v1/auth/verify-code`):** The client sends the user's email and the 6-digit code. The server validates the code. If correct, it either signs the user in (if they exist) or creates a new account and returns a JWT.
1818

19-
<Aside title="Dashboard Login">
19+
<Aside type="note" title="Dashboard Login">
2020
The `request-code` endpoint has a special mode for dashboard logins. If the request includes `"isDashboardLogin": true`, the server first verifies that the user exists and has the necessary `admin` or `publisher` role before sending a code. This prevents unauthorized users from attempting to access the dashboard.
2121
</Aside>
2222

src/content/docs/api-server/getting-started.mdx renamed to src/content/docs/api-server/local-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Getting Started (Local Setup)
2+
title: Local Setup
33
description: A step-by-step guide to configuring and running the API server on your local machine.
44
---
55

src/content/docs/mobile-client/getting-started/local-setup.mdx renamed to src/content/docs/mobile-client/local-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Local Setup Guide
2+
title: Local Setup
33
description: Learn how to set up and run the Flutter mobile client on your local machine.
44
---
55
import { Steps } from '@astrojs/starlight/components';

src/content/docs/web-dashboard/getting-started/local-setup-dashboard.mdx renamed to src/content/docs/web-dashboard/local-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Local Setup: Web Dashboard'
2+
title: Local Setup'
33
description: A step-by-step guide to configuring and running the web dashboard locally.
44
---
55

0 commit comments

Comments
 (0)