Summary
Add deployment guidance and runtime environment validation for the dashboard, integration client, optional Discord bot, and optional docs workspace.
Current Behaviour
The README covers local installation, mock data, development, build, start, typecheck, and lint commands. It does not provide a production deployment guide or central validation of required environment variables for live integrations.
Expected Behaviour
Maintainers should have a clear path for deploying the dashboard and enabling optional integrations safely.
Suggested Implementation
Add a deployment guide covering dashboard-only deployment, live integration mode, optional Discord bot deployment, docs deployment, environment variables, and smoke checks. Add environment parsing and validation where runtime values are used.
Files or Areas Likely Affected
README.md
docs/deployment.md
.env.example
apps/dashboard/lib/env.ts
apps/discord-bot/
apps/docs/
package.json
Acceptance Criteria
Additional Notes
Avoid documenting real credentials. Mark optional legacy workspaces clearly so dashboard-only deployments are not blocked by them.
Summary
Add deployment guidance and runtime environment validation for the dashboard, integration client, optional Discord bot, and optional docs workspace.
Current Behaviour
The README covers local installation, mock data, development, build, start, typecheck, and lint commands. It does not provide a production deployment guide or central validation of required environment variables for live integrations.
Expected Behaviour
Maintainers should have a clear path for deploying the dashboard and enabling optional integrations safely.
Suggested Implementation
Add a deployment guide covering dashboard-only deployment, live integration mode, optional Discord bot deployment, docs deployment, environment variables, and smoke checks. Add environment parsing and validation where runtime values are used.
Files or Areas Likely Affected
README.mddocs/deployment.md.env.exampleapps/dashboard/lib/env.tsapps/discord-bot/apps/docs/package.jsonAcceptance Criteria
Additional Notes
Avoid documenting real credentials. Mark optional legacy workspaces clearly so dashboard-only deployments are not blocked by them.