User Account Service (UAS)

Appearance

Deploy & Publish ​

Docs build/publish (repo-wide) ​

  • VitePress sources live under:
    • Common: docs/common
    • UAS: uservice/uas/docs (this folder)
    • USM/OFM/MRS/PVM: uservice/<svc>/docs
  • Build (all services at once): BUILD_MAJOR=MONDAY BUILD_MINOR=$(date -u +%s) npm run docs:build
    • Outputs to dist/docs with per-service folders (dist/docs/uas, dist/docs/usm, etc).
    • Mirrors service PROTOCOL.md files into the doc output and stamps the build footer.
  • Publish docs (CloudFront + S3): npm run docs:publish
    • Syncs dist/docs to the doc site S3 bucket and invalidates the CloudFront distribution.
    • Requires AWS_PROFILE, AWS_REGION, DOC_BUCKET, and DOC_CF_DISTRIBUTION_ID environment variables.

MCP protocol doc (unauthenticated) ​

  • Source: uservice/uas/mcp/PROTOCOL.md
  • Target host: mcp.g3nretailstack.com via API Gateway custom domain.
  • Publish (CloudFront + S3): npm run mcp:publish
    • Requires AWS_PROFILE, AWS_REGION, MCP_BUCKET, and MCP_CF_DISTRIBUTION_ID environment variables.
    • Exposes protocol markdown as static content; keep it free of secrets/PII.

Reminders ​

  • Use the correct AWS profile and region for your environment.
  • After publish, verify https://doc.g3nretailstack.com/uas/ and https://mcp.g3nretailstack.com/uas/PROTOCOL.md.