Skip to content

docs: define trusted server adapter and add deployment topology#56

Merged
Bccorb merged 1 commit into
mainfrom
docs/deployment-topology
Jul 6, 2026
Merged

docs: define trusted server adapter and add deployment topology#56
Bccorb merged 1 commit into
mainfrom
docs/deployment-topology

Conversation

@Bccorb

@Bccorb Bccorb commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

The docs reference a "trusted server adapter" 7+ times (README, architecture, production-operations) but never define it, and there was no topology diagram showing how the pieces fit. A newcomer could not place themselves in the architecture.

This adds a Deployment Topology section to docs/architecture.md with:

  • A Mermaid diagram (GitHub-rendered): browser → adapter → API → Postgres, labeled with the cookie/Bearer boundary and JWKS verification.
  • A concrete definition of the trusted server adapter: what it is, why it is "trusted", and its responsibilities (cookie↔Bearer bridging, service token, forwarded client IP, JWKS signature verification).
  • A note on direct browser→API integration being possible but unsupported for cookie-based sessions, with token custody kept in the adapter as the recommended path.

Cross-links ecosystem.md for the full contract-coupling map.

Notes

  • Docs-only; no code or contract changes, no changeset.

Add a Deployment Topology section to the architecture guide with a
Mermaid diagram (browser -> adapter -> API -> Postgres) and a concrete
definition of the trusted server adapter: what it is, why it is trusted,
and its responsibilities (cookie/Bearer bridging, service token, JWKS
verification). The term was referenced throughout the docs but never
defined. Cross-links ecosystem.md.
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Bccorb Bccorb merged commit 7ce3a89 into main Jul 6, 2026
2 of 3 checks passed
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.

2 participants