Skip to content

docs(readme): adapter ecosystem index (10 public adapters + future verified-third-party section)#104

Merged
Pomdapis merged 2 commits into
mainfrom
docs/readme-adapters-index
May 18, 2026
Merged

docs(readme): adapter ecosystem index (10 public adapters + future verified-third-party section)#104
Pomdapis merged 2 commits into
mainfrom
docs/readme-adapters-index

Conversation

@Pomdapis
Copy link
Copy Markdown
Contributor

Summary

Closes the README drift from ADR-0006 (multi-repo adapter split) and surfaces the 3 new adapters that just shipped (POM-507 pgvector / POM-508 openai / POM-509 anthropic).

What changes

  • New `## Adapters` section near the top of the README listing the 10 public Sassy adapter repos:

    Domain Adapter Repo
    Persistence PostgreSQL, Redis, Pgvector (new) 3 repos
    Identity Zitadel 1 repo
    Billing Stripe, LemonSqueezy 2 repos
    Email Listmonk 1 repo
    AI gateway OpenRouter 1 repo
    AI direct OpenAI (new), Anthropic (new) 2 repos
  • Reserves a `### Verified third-party adapters` placeholder for the future external-contributor flow (security review, namespacing, tenancy, Result-pattern, ≥ 90 % coverage gate).

  • Points contributors at `template-compendium-adapter-dotnet` for writing their own.

  • Trims `## Packages` to the framework-only set:

    • Removes the 7 extracted-adapter rows (now under Adapters)
    • Removes the deprecated `Compendium.Extensions.ExternalAdapters` row (removed in v1.0.0 per ADR-0006)
    • Adds `Compendium.Abstractions.VectorStore` and `Compendium.Abstractions.Search` rows that were missing
  • Updates the "Modular adapters" bullet in "Why Compendium?" to mention ten production adapters and link to the new section.

Why

Per memory `project_compendium_readme_adapter_index.md` (saved earlier today), the Compendium README is the public-facing entrypoint and must always advertise the official adapter ecosystem at the top. Every new public adapter ship updates this table — same row format as `docs/adapters/external.md` (kept in sync).

Test plan

  • CI green.
  • Visual check of rendered README on the PR view.

Closes the README drift from ADR-0006 (multi-repo adapter split) + the
3 new AI/vector adapters shipped today (POM-507/508/509).

- Adds `## Adapters` section near the top of the README with the
  10 public Sassy adapter repos (PostgreSQL, Redis, Pgvector, Zitadel,
  Stripe, LemonSqueezy, Listmonk, OpenRouter, OpenAI, Anthropic).
- Reserves a `### Verified third-party adapters` placeholder for the
  future external-contributor flow.
- Points contributors at `template-compendium-adapter-dotnet` for
  writing their own.
- Trims `## Packages` to the framework-only set: removes the 7
  extracted-adapter rows (now under "Adapters") plus the deprecated
  `Compendium.Extensions.ExternalAdapters` row (removed in v1.0.0
  per ADR-0006). Adds `Compendium.Abstractions.VectorStore` and
  `Compendium.Abstractions.Search` rows that were missing.
- Updates the "Modular adapters" bullet to reflect the ecosystem.
Copilot AI review requested due to automatic review settings May 17, 2026 17:52
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Phase 4 brought 4 more adapters online: Qdrant (vector), S3-compatible
object storage, Gemini (Google AI), Ollama (local LLM). Adapter index
now lists 14 production adapters.
@Pomdapis Pomdapis merged commit d6e36f3 into main May 18, 2026
5 checks passed
@Pomdapis Pomdapis deleted the docs/readme-adapters-index branch May 18, 2026 14:21
This was referenced May 21, 2026
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