Skip to content

docs: align Realtime architecture references - #472

Open
ikenyal wants to merge 2 commits into
aws-devtools-labs:mainfrom
ikenyal:docs/realtime-api-gateway-architecture
Open

docs: align Realtime architecture references#472
ikenyal wants to merge 2 commits into
aws-devtools-labs:mainfrom
ikenyal:docs/realtime-api-gateway-architecture

Conversation

@ikenyal

@ikenyal ikenyal commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Problem

Several public-facing descriptions still identify Realtime as AppSync Events or IoT even though the current implementation provisions API Gateway WebSocket with DynamoDB-backed connection tracking. This affects architecture, service-limit, and cost decisions for users of the bb-realtime package and the blocks umbrella package, as well as contributors using the protocol-extension references.

Issue #, if available: N/A

Changes

  • Correct the Realtime public JSDoc and umbrella-package description to name API Gateway WebSocket + DynamoDB.
  • Replace obsolete AppSync-specific scaling and cost claims with accurate descriptions and a link to the Realtime documentation.
  • Align Agent design/cost documentation, the Agent source comment, and the comprehensive-app FAQ with the deployed architecture.
  • Update the protocol-extension examples and Transferable design reference to show API Gateway Management API fan-out and DynamoDB-backed connection tracking instead of AppSync/IoT.
  • Keep AppSync references that explicitly describe the previous implementation or list it as an external alternative.

Validation

  • Ran npm run sync-docs:check.
  • Ran git diff --check.
  • Verified the revised descriptions against the Realtime CDK and AWS runtime implementations, README, and design document.
  • Confirmed that remaining AppSync references in the affected areas are explicitly historical or describe an external alternative.

No automated tests were added because this is a documentation-only correction. No changeset is needed because no published package behavior changes.

Checklist

  • PR description included
  • Tests are changed or added
  • Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@ikenyal
ikenyal requested a review from a team as a code owner September 1, 2026 20:07
@changeset-bot

changeset-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: cb41f1a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ikenyal
ikenyal force-pushed the docs/realtime-api-gateway-architecture branch from 410353c to cb41f1a Compare September 8, 2026 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant