Development and deployment
Local application
git clone https://github.com/sajeetharan/devglobe.git
cd devglobe
npm install
npm run devWithout Cosmos DB credentials, the application falls back to bundled sample data. Text search works locally; vector and hybrid search require Azure Cosmos DB and Azure OpenAI configuration.
Documentation
npm run docs:dev
npm run docs:build
npm run docs:previewdocs:build runs VitePress and verifies the emitted /devglobe/ base paths and internal assets. VitePress also fails on unresolved internal Markdown links.
Set DOCS_BASE=/ for a future custom documentation domain. Set DOCS_SITE_URL to its canonical origin so the generated sitemap remains correct.
Deployment ownership
| Surface | Host | Workflow |
|---|---|---|
| Dynamic application and APIs | Vercel | .github/workflows/deploy.yml |
| Static documentation | GitHub Pages | .github/workflows/docs-pages.yml |
The Pages workflow builds on pull requests and deploys only pushes to main. It does not export or replace the dynamic application.
Contribution checks
Before opening a pull request:
npm test
npm run docs:build
npm run buildKeep one canonical source for each topic. Product and integration guides belong under docs-site/; implementation PRDs remain under docs/prd/. Update API and agent documentation when their public contracts change.
