Skip to content

docs(readme): make the Integrations section seam-centric (follow-up to #180) - #182

Open
H0BB5 wants to merge 1 commit into
mainfrom
docs/integrations-seam-centric
Open

docs(readme): make the Integrations section seam-centric (follow-up to #180)#182
H0BB5 wants to merge 1 commit into
mainfrom
docs/integrations-seam-centric

Conversation

@H0BB5

@H0BB5 H0BB5 commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Follow-up to #180. Reworks Integrations from a Modules-vs-seams split into a single seam-keyed table, because the "Modules" framing over-promised: authz and audit are ports (AuthorizationServerAdapter, AuditRecorder) with reference/default implementations, not turnkey integrations — the real work is "implement this interface."

  • One table keyed on the seam/port: DID resolution, revocation, authorization (GenericOidcAdapter reference → your IdP), state, audit delivery, crypto, policy — each with its reference/default and what you bring.
  • cheqd — the one fully-realized external integration — gets its own worked-example subsection (it fills the DID-resolution, revocation, and audit-anchoring seams at once), keeping the enable snippet and the link to its co-located src/integrations/cheqd/README.md.

Reads truer to the adapter-pattern model and invites contribution harder. Docs only; all link targets and the #multi-instance-deployments anchor verified.

Follow-up to #180. Collapses the Modules-vs-seams split into one seam-keyed
table: authz and audit are ports (AuthorizationServerAdapter, AuditRecorder),
not turnkey modules, so listing them under "Modules" over-promised a plug-in
that is really "implement this interface." cheqd — the one fully-realized
external integration — moves to its own worked-example subsection (it fills the
DID-resolution, revocation, and audit-anchoring seams at once). Reads truer to
the adapter-pattern model and invites contribution. Docs only.

Signed-off-by: h0bb5 <dylanjhobbs+2@gmail.com>
@github-actions

Copy link
Copy Markdown

Coverage Report

Metric Coverage Delta
Statements 93.99% ±0
Branches 87.96% ±0
Functions 95.81% ±0
Lines 94.71% ±0
Details
  • Tests: 2065 passed (2066 total across 149 files)
  • Overall coverage: 93.99% statements
  • Config: vitest + v8, thresholds enforced in vitest.config.mts

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