docs: add public API compatibility matrix - #163
Open
CleanDev-Fix wants to merge 1 commit into
Open
Conversation
CleanDev-Fix
marked this pull request as ready for review
July 30, 2026 00:37
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
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.
Description
Adds a source-backed public API compatibility matrix for Aegis SDK consumers.
It maps the package's root and testing entry points, module/export stability,
companion-contract dependencies and current drift, planned dashboard adapter
targets, and pre-1.0 breaking-change rules. The README now links directly to
the matrix.
This approach keeps the change documentation-only while making cross-repo
assumptions reviewable. It also distinguishes repository contract
specifications from proof of any deployed contract interface.
Files changed:
docs/public-api-compatibility.md— new compatibility contract, matrices,drift snapshot, dashboard target, breaking-change rules, and reviewer list.
README.md— link and integration guidance for the matrix.Closes: #152
Evidence Checklist
1. Issue Reference
Closes #152).2. Implementation Summary
3. Tests
applicable.
compatibility regressions.
Markdown tables, and whitespace.
4. Commands Run
Command output
5. CI Status
hosted checks run.
6. Acceptance Criteria Coverage — Traceability Table
docs/public-api-compatibility.mdAegisClient, client factories, six modules, helpers, types, errors, and testing surfacenpm run check; source-to-matrix QAsrc/index.ts,src/testing/index.ts, andpackage.json#exports.README.mddocs/public-api-compatibility.md.Reviewer Notes
Please pay particular attention to the rows marked
Preview, especially theinvestor balance entrypoint, role discovery, and event-topic parity. The
matrix documents current drift; this PR does not change runtime behavior or
claim that a repository specification proves a deployed interface.