Skip to content

fix: add Vercel deploy config and workflow for docs site#1739

Open
MeGaurav4 wants to merge 1 commit into
headroomlabs-ai:mainfrom
MeGaurav4:fix/vercel-docs-deploy-1730
Open

fix: add Vercel deploy config and workflow for docs site#1739
MeGaurav4 wants to merge 1 commit into
headroomlabs-ai:mainfrom
MeGaurav4:fix/vercel-docs-deploy-1730

Conversation

@MeGaurav4

@MeGaurav4 MeGaurav4 commented Jul 3, 2026

Copy link
Copy Markdown

Description

The Vercel docs site at headroom-docs.vercel.app had no automated deployment pipeline, so newly added pages (persistent-installs, savings) return 404 despite existing in the repo and building correctly locally.

Closes #1730

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking function added)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Performance improvement
  • Code refactoring (no functional changes)

Changes Made

  • Add docs/vercel.json with explicit Next.js project config (framework, build/install commands)
  • Add deploy-vercel job to .github/workflows/docs.yml to auto-deploy on pushes to main touching docs/**

Testing

  • Unit tests pass (pytest)
  • Linting passes (ruff check .)
  • Type checking passes (mypy headroom)
  • New tests added for new functionality
  • Manual testing performed

Test Output

Local build verification:
cd docs && npm ci && npm run build
Build succeeded - persistent-installs and savings pages

Real Behavior Proof

  • Environment: Linux x86_64, Node.js 20
  • Observed result: Both pages build and render correctly locally
  • Not tested: Live Vercel deployment (requires maintainer secrets)

Review Readiness

  • I have performed a self-review
  • This PR is ready for human review

Additional Notes

Requires three repo secrets: VERCEL_TOKEN, VERCEL_ORG_ID, VERCEL_PROJECT_ID.

The Vercel docs site at headroom-docs.vercel.app had no automated
deployment pipeline, so newly added pages (persistent-installs,
savings) return 404 despite existing in the repo and building
correctly locally.

- Add docs/vercel.json with explicit Next.js project config
- Add deploy-vercel job to docs.yml to auto-deploy on pushes
  to main touching docs/

Closes headroomlabs-ai#1730
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

PR governance

This PR does not yet satisfy the required template fields:

  • Fill in Real Behavior ProofExact command / steps.

Please update the PR body, or move the PR back to draft while it is still in progress.

@github-actions github-actions Bot added the status: needs author action Pull request body or readiness checklist still needs author updates label Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: needs author action Pull request body or readiness checklist still needs author updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Vercel docs site stale (404 for /docs/persistent-installs and /docs/savings)

1 participant