Skip to content

Commit 8a32384

Browse files
docs: improved file structure
1 parent 21f04eb commit 8a32384

File tree

4 files changed

+11
-12
lines changed

4 files changed

+11
-12
lines changed

apps/docs/docs/guides/create-new-block/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Create a new block",
3-
"position": 900,
3+
"position": 500,
44
"link": {
55
"type": "doc",
66
"id": "overview"

apps/docs/docs/guides/deployment/_category_.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
{
22
"label": "Deployment",
3-
"position": 6,
3+
"position": 600,
44
"link": {
5-
"type": "generated-index",
6-
"title": "Deployment",
7-
"description": "How to deploy Open Self Service using Docker and Vercel."
5+
"type": "doc",
6+
"id": "overview"
87
}
98
}
109

apps/docs/docs/guides/deployment/docker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This will:
2929
- Build `apps/frontend/Dockerfile` and expose it on `http://localhost:3000`
3030
- Build `apps/api-harmonization/Dockerfile` and expose it on `http://localhost:3001`
3131

32-
Environment variables
32+
## Environment variables
3333

3434
The `docker-compose.yml` includes sane defaults. Adjust as needed (especially external API keys).
3535

@@ -48,7 +48,7 @@ The `docker-compose.yml` includes sane defaults. Adjust as needed (especially ex
4848
- Optional logging: `LOG_LEVEL`, `LOG_FORMAT`, `LOG_COLORS_ENABLED`
4949
- Integrations: see `/docs/integrations` for provider-specific variables (e.g. `CMS_STRAPI_BASE_URL`, `ALGOLIA_*`, `MEDUSAJS_*`, `CACHE_*`, etc.)
5050

51-
Useful commands
51+
## Useful commands
5252

5353
```bash
5454
# View logs
@@ -82,7 +82,7 @@ docker run --rm -p 3001:3001 --network app_network \
8282

8383
**Note:** The Dockerfiles use Turborepo's `turbo prune` with `@dxp/frontend` and `@dxp/api-harmonization` package names internally. This is handled automatically by the build process.
8484

85-
Example Dockerfiles
85+
## Example Dockerfiles
8686

8787
See the repository for maintained examples:
8888

apps/docs/docs/guides/deployment/vercel.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Configure a monorepo deployment of the Next.js frontend to Vercel.
55

66
This section covers deploying the Next.js `frontend` app to Vercel. The NestJS API is best deployed as a container (see [Deploy with Docker](./docker)).
77

8-
Project settings
8+
## Project settings
99

1010
1) Import the GitHub repository into Vercel.
1111
2) In Project Settings → General:
@@ -16,7 +16,7 @@ Project settings
1616
- Build Command (monorepo with Turborepo): `npx turbo run build --filter=frontend`
1717
- Output Directory: (handled by Next.js)
1818

19-
Environment variables
19+
## Environment variables
2020

2121
Add these variables in Project Settings → Environment Variables for Preview and Production:
2222

@@ -27,13 +27,13 @@ Add these variables in Project Settings → Environment Variables for Preview an
2727
- Optional logging: `NEXT_PUBLIC_LOG_LEVEL`, `NEXT_PUBLIC_LOG_FORMAT`, `NEXT_PUBLIC_LOG_COLORS_ENABLED`
2828
- Auth (optional): `AUTH_GITHUB_ID`, `AUTH_GITHUB_SECRET`, `AUTH_GOOGLE_ID`, `AUTH_GOOGLE_SECRET`, `AUTH_SECRET`, `AUTH_DEFAULT_USER_ROLE`
2929

30-
Notes
30+
## Notes
3131

3232
- API hosting: Historically, Vercel Serverless was not recommended for the NestJS API in this repository. However, Vercel has recently added improved backend support (including NestJS). For now we recommend deploying the API as a container (Docker on VM/Kubernetes/Fly.io/Render/etc.) and exposing a public URL consumed by the frontend, but this is under evaluation and may change. We plan to investigate first-class Vercel API hosting and update this guide accordingly.
3333
- CORS: Ensure the API’s `FRONT_BASE_URLS` includes your Vercel domains (both Preview and Production), e.g. `https://your-app.vercel.app,https://your-branch-your-team.vercel.app`.
3434
- Images and headers: If you use custom headers or remote images, configure them in `apps/frontend/next.config.ts`.
3535

36-
Production checks
36+
## Production checks
3737

3838
After the first deployment:
3939

0 commit comments

Comments
 (0)