@@ -11,20 +11,23 @@ The repository is configured to automatically deploy PR previews to Vercel when
1111To enable PR deployments to Vercel, follow these steps:
1212
13131 . ** 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:
3336When a PR is opened or updated that includes changes to the ` docs/ ` directory:
3437
35381 . 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
4649If you encounter issues with the Vercel deployment:
4750
48511 . 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
0 commit comments