docs(readme): focus on existing customers + point to catalog ecosystem - #63
Merged
Merged
Conversation
This repo is the canonical Forge module library for BNK 2.2 GA on existing Forge installations. The README was written when this was the only catalog — now there's a per-target catalog ecosystem (bnk-forge-catalog-* repos) and the README needed to reflect that without forcing existing customers to migrate. What changed: - Reframed the intro: this is the original Forge module library for BNK 2.2 GA, used by existing Forge installations. - Added a non-aggressive pointer at the top: 'new installations may also want to look at the per-target catalogs' — without deprecation pressure. - Trimmed the 'Canonical Catalog Contract' verbose metadata block — moved the validators and contract file references into a tight 'Repository contract' section. - Replaced the Repository Structure ASCII tree (88 lines) with a compact family table. - Replaced the four separate deployment flow tables with a single ASCII dependency diagram. - New 'The catalog ecosystem' section lists every per-target catalog with status (live, in progress, planned) so existing customers can see where things are heading. - Removed stale 'Last Tested 2026-02-10' badge — not the user's focus. Bump VERSION to 2.2-rev.33.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The previous README was written when this was the only Forge module library. Now there's a per-target catalog ecosystem (
bnk-forge-catalog-shared,bnk-forge-catalog-aws-eks, jgruber's IBM catalog, planned Azure/GCP/on-prem). The README needs to reflect that — without forcing existing customers to migrate.What changed
Net: 154 lines → 64 lines, no information loss for the audience this repo actually serves.
Test plan
release/2.2. Existing Forge installations pointing at this URL keep working unchanged.