Skip to content

Commit 04f97ad

Browse files
committed
docs(api-server): update content and structure for clarity and comprehensiveness
- Rename 'API Server' to 'API Server: Introduction' for specificity - Adjust description to mention Flutter News App toolkit instead of ecosystem - Rename 'Getting Started' to 'Local Setup' for accuracy - Add new 'Features' and 'Architecture' cards to enhance content structure - Update card links to reflect new document structure - Broaden 'How-To Guides' description to encompass various configuration tasks
1 parent 09279bd commit 04f97ad

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

src/content/docs/api-server/index.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: API Server
3-
description: An overview of the high-performance Dart Frog backend that powers the Flutter News App ecosystem.
2+
title: 'API Server: Introduction'
3+
description: An overview of the high-performance Dart Frog backend that powers the Flutter News App toolkit.
44
---
55

66
import { Card, CardGrid } from '@astrojs/starlight/components';
@@ -10,24 +10,28 @@ The API Server is the core backend component of the Flutter News App Toolkit. Bu
1010
It is designed to work seamlessly with the [Mobile Client](/docs/mobile-client/) and the [Web Dashboard](/docs/web-dashboard/).
1111

1212
<CardGrid>
13-
<Card title="Getting Started" icon="rocket">
13+
<Card title="Local Setup" icon="rocket">
1414
Follow the local setup guide to get the server running on your machine.
15-
[Read more &rarr;](/docs/api-server/getting-started/)
15+
[Read more &rarr;](/docs/api-server/local-setup/)
1616
</Card>
1717
<Card title="Deployment" icon="cloud">
1818
Learn how to deploy the API server to a production environment.
1919
[Read more &rarr;](/docs/api-server/deployment/)
2020
</Card>
2121
<Card title="Features" icon="puzzle">
22-
Explore the key features and architecture of the API server.
23-
[Read more &rarr;](/docs/api-server/features/authentication/)
22+
Explore the key features of the API server, from authentication to data management.
23+
[Read more &rarr;](/docs/api-server/features/)
24+
</Card>
25+
<Card title="Architecture" icon="tree-structure">
26+
Dive into the architectural patterns that make the server robust and maintainable.
27+
[Read more &rarr;](/docs/api-server/architecture/)
2428
</Card>
2529
<Card title="API Reference" icon="open-book">
2630
A complete reference for all API endpoints and data models.
2731
[Read more &rarr;](/docs/api-server/reference/)
2832
</Card>
2933
<Card title="How-To Guides" icon="document">
3034
Practical guides for specific configuration and setup tasks.
31-
[Read more &rarr;](/docs/api-server/guides/configure-environment-variables/)
35+
[Read more &rarr;](/docs/api-server/guides/)
3236
</Card>
3337
</CardGrid>

0 commit comments

Comments
 (0)