Deployment
Static site deployment
This docs site is currently set up for static deployment on Vercel. The main goal is to keep publishing low-friction while preserving confidence that visuals, links, and navigation still work once the site is live.
Current production target
- Hosting: Vercel
- URL: https://docs.builderinsights.app
Required Vercel settings
| Setting | Value |
|---|---|
| Framework Preset | Other |
| Install Command | npm install |
| Build Command | npm run build |
| Output Directory | build |
First deploy flow
Bring the GitHub repository into Vercel and keep the root directory set to the repo root.
Use the expected install, build, and output values so Docusaurus publishes the generated `build` directory.
Open the generated preview URL and confirm that the site renders correctly before treating the deployment as done.
After deployment
QA check
Post-deploy smoke checks
- confirm the home page renders correctly in light and dark theme
- spot-check flagship docs pages, screenshot pages, and sidebar navigation
- verify image assets, illustrations, and Mermaid diagrams load correctly
- verify internal links and footer navigation still behave as expected
Repo support files
This repo includes the expected Vercel build configuration so deploy behavior stays explicit and reviewable.
Keep the site URL, branding, and navigation references aligned with the current production deployment.
If the hosting target changes later
Decision
What must be updated for a new domain or host
- update `docusaurus.config.ts` `url` and any related navigation references
- review product and repo references that still mention the previous deployment URL
- re-run build and a post-deploy smoke pass before announcing the new URL broadly