Deployment
This repository validates deployable artifacts but does not own a production deployment. The consuming environment owns hosting, access controls, secrets, observability, and release policy.
Documentation Artifact
Build and validate the static VitePress site with:
bash
npm ci
npm run docs:validateThe output is written to docs/.vitepress/dist and can be served by any static hosting provider. It includes llms.txt, llms-full.txt, and page-level Markdown for agent clients.
MCP And Slack Runtime
Build the Node.js runtime with:
bash
npm run mcp:buildFor local HTTP operation:
bash
npm run mcp:httpFor a prebuilt production artifact:
bash
npm run runtime:startThe HTTP server exposes /healthz, /readyz, /mcp, and /slack/events. The included Dockerfile builds a non-root Node.js 20 image on port 8080 and uses /readyz for its health check.
Consumer Responsibilities
- Set
INDEX_ROOT,HOST, andPORTfor the runtime environment when defaults are unsuitable. - Store
SLACK_BOT_TOKENandSLACK_SIGNING_SECRETin the deployment platform, never in repository files. - Restrict Slack access through
slack/access-policy.jsonand, when needed,SLACK_ALLOWED_TEAM_ID. - Put HTTPS, authentication, network policy, logs, monitoring, backups, and rollback controls around the deployed service.
- Keep the runtime read-only unless a separately reviewed capability explicitly requires mutation.
The documentation site and Node.js runtime are separate artifacts and may be deployed independently.