Skip to content

Add Aegis SDK public API compatibility matrix #152

Description

@El-swaggerito

Description

Difficulty: Hard

Type: Documentation

Summary

Add a public API compatibility matrix for Aegis SDK modules.

Current Behaviour

SDK exports may drift from dashboard and contract expectations.

Expected Behaviour

The SDK should document exported modules, method stability, contract dependencies, dashboard consumers, and breaking-change rules.

Suggested Implementation

Create compatibility matrix documentation and README links.

Files or Areas Likely Affected

  • docs/
  • README.md
  • src/

Acceptance Criteria

  • Public API compatibility matrix is added.
  • Major SDK exports are listed.
  • Contract dependencies are documented.
  • Dashboard consumers are referenced.
  • Breaking-change guidance is included.
  • README links to the matrix.

Additional Notes

This reduces cross-repo drift.

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelaegisAegis RWA Protocol related workdeveloper-experienceDeveloper experience workdocumentationDocumentation workhardHard difficultysdkSDK related work

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions