Skip to content

docs: add topology diagram, compatibility matrix and fit guidance - #65

Merged
Bccorb merged 1 commit into
mainfrom
docs/front-door-topology-compat
Oct 7, 2026
Merged

Bccorb merged 1 commit into
mainfrom
docs/front-door-topology-compat

Conversation

@Bccorb

@Bccorb Bccorb commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

Summary

The docs-repo half of #45.

  • Topology diagram on the landing page (start/overview.mdx, new src/components/TopologyDiagram.astro): browser (React SDK, signed httpOnly cookies) and native app (react-native, bearer transport) both go through your backend adapter to seamless-auth-api, which owns the session, uses Postgres, and publishes JWKS. It is an inline SVG themed with Starlight variables, with role="img", a title and description, and a text explanation below. It is checked against seamless-auth-server main (core/src/transport.ts, applyResult.ts, jwks.ts, guards.ts). I checked it rendered in both light and dark themes.
  • Compatibility matrix in build/ecosystem.mdx: every package's version on main (npm latest matched on 2026-10-06) and its declared ranges on the others, plus what seamless-cli 0.18.0 scaffolds and the steps to refresh the matrix each release.
  • Ecosystem table: client, react-native, nextjs, and fastify were already listed. This adds the missing doc links.
  • "When Seamless Auth Is Not The Right Choice" on the overview: no password login, no SAML or IdP role, Node-only server SDKs, a backend is required, React-only frontend bindings, the cost of self-hosting, and 0.x versioning. Each is checked against source.

Drift the matrix surfaced

  • seamless-cli scaffolds API image v0.13.1 (API is 0.16.0), dashboard v0.7.0 (dashboard is 0.8.0), and templates that pin older SDK minors.
  • The dashboard pins @seamless-auth/react ^0.13.0 (current is 0.15.0).
  • client, react, react-native, and cli declare types ^0.26.0 while types is 0.27.0.
  • @seamless-auth/nextjs declares no next peer dependency.

Remaining for #45 (outside this repo)

  • The topology diagram and a "start here" link in each repo README.
  • Publishing the matrix from the release process.
  • Per-source migration guides as seamless migrate sources land.

Testing

npm run lint, npm run typecheck, and npm run build pass.

Refs #45

The landing page now shows how the browser, the native app, the server
adapter and the auth API connect, and states that the auth API owns the
session while the adapter keeps browser tokens in signed cookies and
native apps hold bearer tokens. The diagram is an inline SVG component
themed with Starlight variables so it follows light and dark mode.

The ecosystem page gains a compatibility matrix read from each
repository's main branch on 2026-10-06, a table of what seamless-cli
0.18.0 scaffolds, and the steps to keep both current each release. The
ecosystem table links the Fastify, React Native and client rows to
their docs.

The overview also lists the constraints that make Seamless Auth the
wrong fit: no password login, no SAML or OIDC provider role, Node-only
server SDKs, a required backend, React-only frontend bindings, the
operating cost of self-hosting, and 0.x versioning.

Refs #45
@Bccorb
Bccorb merged commit e4b8c13 into main Oct 7, 2026
3 checks passed
@Bccorb
Bccorb deleted the docs/front-door-topology-compat branch October 15, 2026 03:11
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