Skip to content

Commit 3fe1456

Browse files
committed
docs: rename API server guide pages and update links
- Rename 'how-to' to 'guides' in URLs for better categorization - Update all internal links to reflect the new URL structure - Rename 'api-reference' to 'reference' for shorter, more concise URLs - Update navigation menu and card grid links to match new structure
1 parent 8645138 commit 3fe1456

File tree

9 files changed

+23
-23
lines changed

9 files changed

+23
-23
lines changed

astro.config.mjs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ export default defineConfig({
5050
label: 'Guides',
5151
collapsed: true,
5252
items: [
53-
{ label: 'Overview', link: '/api-server/how-to/' },
54-
{ label: 'Configure Environment Variables', link: '/api-server/how-to/configure-environment-variables' },
55-
{ label: 'Configure MongoDB', link: '/api-server/how-to/configure-mongodb' },
56-
{ label: 'Configure CORS', link: '/api-server/how-to/configure-cors' },
57-
{ label: 'Implement an Alternative Email Client', link: '/api-server/how-to/implement-alternative-email-client' },
53+
{ label: 'Overview', link: '/api-server/guides/' },
54+
{ label: 'Configure Environment Variables', link: '/api-server/guides/configure-environment-variables' },
55+
{ label: 'Configure MongoDB', link: '/api-server/guides/configure-mongodb' },
56+
{ label: 'Configure CORS', link: '/api-server/guides/configure-cors' },
57+
{ label: 'Implement an Alternative Email Client', link: '/api-server/guides/implement-alternative-email-client' },
5858
],
5959
},
6060
{

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The world of cloud hosting and deployment tools evolves rapidly. Instead of prov
1616

1717
Your first step is to prepare the production configuration for the server. Unlike local development which uses a `.env` file, in production you will use your hosting provider's interface to set environment variables securely.
1818

19-
For a detailed explanation of each required variable, please see the [Configure Environment Variables](/docs/api-server/how-to/configure-environment-variables) guide.
19+
For a detailed explanation of each required variable, please see the [Configure Environment Variables](/docs/api-server/guides/configure-environment-variables) guide.
2020

2121
2. **Choose a Deployment Strategy**
2222

@@ -39,6 +39,6 @@ The world of cloud hosting and deployment tools evolves rapidly. Instead of prov
3939

4040
For your web-based dashboard to communicate with the API in production, you must correctly configure Cross-Origin Resource Sharing (CORS).
4141

42-
For instructions, see the [Configure CORS](/docs/api-server/how-to/configure-cors) guide.
42+
For instructions, see the [Configure CORS](/docs/api-server/guides/configure-cors) guide.
4343

4444
</Steps>

src/content/docs/api-server/features/email-service.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ When a user requests a sign-in code, the `AuthService` calls the `EmailRepositor
2626
<Aside type="tip" title="Architectural Benefit">
2727
This decoupled design makes the system highly maintainable and flexible. If you ever want to switch from SendGrid to another email provider (like Mailgun or AWS SES), you only need to create a new class that implements the `EmailClient` interface and update a single line in the dependency injection configuration.
2828

29-
For a practical example, see the [Implement an Alternative Email Client](/docs/api-server/how-to/implement-alternative-email-client) guide.
29+
For a practical example, see the [Implement an Alternative Email Client](/docs/api-server/guides/implement-alternative-email-client) guide.
3030
</Aside>

src/content/docs/api-server/guides/configure-environment-variables.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The full connection string for your MongoDB instance. The application cannot sta
3232
- **Production:** Use the connection string provided by your database hosting service (e.g., MongoDB Atlas).
3333

3434
<Aside type="tip">
35-
For guidance on setting up a local MongoDB instance, see the [Configure MongoDB](/docs/api-server/how-to/configure-mongodb) guide.
35+
For guidance on setting up a local MongoDB instance, see the [Configure MongoDB](/docs/api-server/guides/configure-mongodb) guide.
3636
</Aside>
3737

3838
#### `JWT_SECRET_KEY`
@@ -80,7 +80,7 @@ The specific origin URL of your web client (e.g., the Flutter Web Dashboard) tha
8080
- **Example:** `https://dashboard.yourdomain.com`
8181

8282
<Aside type="caution">
83-
For more details on CORS, see the [Configure CORS](/docs/api-server/how-to/configure-cors) guide.
83+
For more details on CORS, see the [Configure CORS](/docs/api-server/guides/configure-cors) guide.
8484
</Aside>
8585

8686
#### `SENDGRID_API_URL`

src/content/docs/api-server/guides/configure-mongodb.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,5 @@ DATABASE_URL="mongodb://localhost:27017/flutter_news_app_db"
4848
- `flutter_news_app_db`: You can name your database anything you like. The server will create it automatically on first connection if it doesn't exist.
4949

5050
<Aside type="tip">
51-
For a complete overview of all environment variables, see the [Configure Environment Variables](/docs/api-server/how-to/configure-environment-variables) guide.
51+
For a complete overview of all environment variables, see the [Configure Environment Variables](/docs/api-server/guides/configure-environment-variables) guide.
5252
</Aside>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ This section provides practical, step-by-step guides for specific configuration
1010
<CardGrid>
1111
<Card title="Configure Environment Variables" icon="document">
1212
A detailed guide to setting up your `.env` file.
13-
[Read more &rarr;](/docs/api-server/how-to/configure-environment-variables/)
13+
[Read more &rarr;](/docs/api-server/guides/configure-environment-variables/)
1414
</Card>
1515
<Card title="Configure MongoDB" icon="database">
1616
Learn how to set up a local MongoDB instance using Docker.
17-
[Read more &rarr;](/docs/api-server/how-to/configure-mongodb/)
17+
[Read more &rarr;](/docs/api-server/guides/configure-mongodb/)
1818
</Card>
1919
<Card title="Configure CORS" icon="shield">
2020
Understand and configure Cross-Origin Resource Sharing for production.
21-
[Read more &rarr;](/docs/api-server/how-to/configure-cors/)
21+
[Read more &rarr;](/docs/api-server/guides/configure-cors/)
2222
</Card>
2323
<Card title="Implement an Alternative Email Client" icon="email">
2424
See how to swap out the default email service with your own implementation.
25-
[Read more &rarr;](/docs/api-server/how-to/implement-alternative-email-client/)
25+
[Read more &rarr;](/docs/api-server/guides/implement-alternative-email-client/)
2626
</Card>
2727
<Card title="Understand Database Seeding" icon="seed">
2828
Learn how the server automatically populates the database with initial data.
29-
[Read more &rarr;](/docs/api-server/how-to/understand-database-seeding/)
29+
[Read more &rarr;](/docs/api-server/guides/understand-database-seeding/)
3030
</Card>
3131
</CardGrid>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ It is designed to work seamlessly with the [Mobile Client](/docs/mobile-client/)
2424
</Card>
2525
<Card title="API Reference" icon="open-book">
2626
A complete reference for all API endpoints and data models.
27-
[Read more &rarr;](/docs/api-server/api-reference/)
27+
[Read more &rarr;](/docs/api-server/reference/)
2828
</Card>
2929
<Card title="How-To Guides" icon="document">
3030
Practical guides for specific configuration and setup tasks.
31-
[Read more &rarr;](/docs/api-server/how-to/configure-environment-variables/)
31+
[Read more &rarr;](/docs/api-server/guides/configure-environment-variables/)
3232
</Card>
3333
</CardGrid>

src/content/docs/api-server/local-setup.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ This guide will walk you through setting up the API server in a local developmen
3131

3232
The API server requires a MongoDB database. For local development, the recommended approach is to use Docker.
3333

34-
For a complete walkthrough, follow the [Configure MongoDB for Local Development](/docs/api-server/how-to/configure-mongodb) guide.
34+
For a complete walkthrough, follow the [Configure MongoDB for Local Development](/docs/api-server/guides/configure-mongodb) guide.
3535

3636
4. **Configure Environment Variables**
3737

3838
The server uses a `.env` file to manage secrets and configuration. You will need to create this file and populate it with the correct values for your local environment.
3939

40-
For a detailed walkthrough, follow the [Configure Environment Variables](/docs/api-server/how-to/configure-environment-variables) guide.
40+
For a detailed walkthrough, follow the [Configure Environment Variables](/docs/api-server/guides/configure-environment-variables) guide.
4141

4242
5. **Install Dependencies**
4343

@@ -61,5 +61,5 @@ This guide will walk you through setting up the API server in a local developmen
6161

6262
On its first startup, the server automatically connects to your MongoDB database and seeds it with initial data (countries, topics, users, etc.). This process is idempotent, meaning you can safely restart the server multiple times without creating duplicate data.
6363

64-
For more details on how this works, see the [Understand Database Seeding](/docs/api-server/how-to/understand-database-seeding) guide.
64+
For more details on how this works, see the [Understand Database Seeding](/docs/api-server/guides/understand-database-seeding) guide.
6565
</Steps>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ For a detailed list of possible error codes and their meanings, please see the [
6868
<CardGrid>
6969
<Card title="Authentication" icon="lock">
7070
Endpoints for user sign-up, sign-in, and session management.
71-
[Read more &rarr;](/docs/api-server/api-reference/authentication/)
71+
[Read more &rarr;](/docs/api-server/reference/authentication/)
7272
</Card>
7373
<Card title="Data Access" icon="document">
7474
The generic endpoint for all CRUD operations on data models.
75-
[Read more &rarr;](/docs/api-server/api-reference/data-access/)
75+
[Read more &rarr;](/docs/api-server/reference/data-access/)
7676
</Card>
7777
</CardGrid>

0 commit comments

Comments
 (0)