Skip to content

Commit 289b2ed

Browse files
Automated pre-commit update
1 parent 0118bdf commit 289b2ed

File tree

3 files changed

+20
-17
lines changed

3 files changed

+20
-17
lines changed

.github/workflows/vercel-pr-deployment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ jobs:
2424
vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }}
2525
github-token: ${{ secrets.GITHUB_TOKEN }}
2626
github-comment: true
27-
working-directory: ./
27+
working-directory: ./

docs/VERCEL_DEPLOYMENT.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,23 @@ The repository is configured to automatically deploy PR previews to Vercel when
1111
To enable PR deployments to Vercel, follow these steps:
1212

1313
1. **Create a Vercel Project**:
14+
1415
- Go to [Vercel](https://vercel.com) and create a new project
1516
- Import the `codegen` repository
1617
- Configure the project with the following settings:
1718
- Framework Preset: Other
1819
- Build Command: `echo 'Mintlify docs deployment'`
1920
- Output Directory: `docs`
2021

21-
2. **Configure GitHub Secrets**:
22+
1. **Configure GitHub Secrets**:
23+
2224
- In the GitHub repository settings, add the following secrets:
2325
- `VERCEL_TOKEN`: Your Vercel API token (create one in Vercel account settings)
2426
- `VERCEL_ORG_ID`: Your Vercel organization ID (found in Vercel project settings)
2527
- `VERCEL_PROJECT_ID`: Your Vercel project ID (found in Vercel project settings)
2628

27-
3. **Mintlify Integration**:
29+
1. **Mintlify Integration**:
30+
2831
- Ensure your Mintlify account is connected to the Vercel project
2932
- Mintlify will handle the actual documentation rendering
3033

@@ -33,9 +36,9 @@ To enable PR deployments to Vercel, follow these steps:
3336
When a PR is opened or updated that includes changes to the `docs/` directory:
3437

3538
1. The GitHub workflow `.github/workflows/vercel-pr-deployment.yml` is triggered
36-
2. The workflow deploys the documentation to Vercel
37-
3. A comment is added to the PR with a link to the preview deployment
38-
4. You can view the documentation preview to verify changes before merging
39+
1. The workflow deploys the documentation to Vercel
40+
1. A comment is added to the PR with a link to the preview deployment
41+
1. You can view the documentation preview to verify changes before merging
3942

4043
## Production Deployment
4144

@@ -46,6 +49,6 @@ The production deployment is handled separately and is triggered when changes ar
4649
If you encounter issues with the Vercel deployment:
4750

4851
1. Check that all required secrets are properly configured
49-
2. Verify that the Vercel project settings match the configuration in `vercel.json`
50-
3. Ensure the Mintlify integration is properly set up
51-
4. Check the GitHub Actions logs for any error messages
52+
1. Verify that the Vercel project settings match the configuration in `vercel.json`
53+
1. Ensure the Mintlify integration is properly set up
54+
1. Check the GitHub Actions logs for any error messages

vercel.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"buildCommand": "echo 'Mintlify docs deployment'",
3-
"outputDirectory": "docs",
4-
"framework": "other",
5-
"github": {
6-
"enabled": true,
7-
"silent": true
8-
}
9-
}
2+
"buildCommand": "echo 'Mintlify docs deployment'",
3+
"outputDirectory": "docs",
4+
"framework": "other",
5+
"github": {
6+
"enabled": true,
7+
"silent": true
8+
}
9+
}

0 commit comments

Comments
 (0)