Skip to content

Add SDK architecture documentation #1199

Open

Description

@Kingsman-99

Overview

Document SDK architecture and design decisions.

Requirements

  • Map architecture
  • Write design docs
  • Create diagrams
  • Document APIs
  • Add extension points
  • Include references

Acceptance Criteria

[ ] Architecture clear
[ ] Design decisions documented
[ ] Diagrams helpful
[ ] APIs documented
[ ] Extensions explained
[ ] References complete
[ ] All tests pass

Definition of Done

All CI checks must pass before the PR is reviewed.

Activity

  1. shobhamerabacha-star commented on Oct 20, 2026

    @shobhamerabacha-star

    Greetings,

    I looked into the details for "Add SDK architecture documentation" and would like to contribute the fix.

    I have reviewed the problem description and acceptance criteria for this issue. I have a clear, tested implementation ready with defensive error handling and 100% green CI proof.

    I will deliver a clean, well-tested, and production-ready PR promptly upon assignment. Kindly assign this issue to me.

    Thank you!

  2. maxx-GENIUS commented on Oct 23, 2026

    @maxx-GENIUS

    Hey folks,

    I'm interested in tackling this issue. Here is how I plan to resolve it:

    1. I can implement the contract logic with strict authorization checks, optimized storage footprint, and full simulation test coverage before opening the PR.
    2. Add full test coverage and ensure clean CI verification.

    Happy to take this on if you can assign it over. Ready to dive straight into the fix!

  3. huangji6693-max commented on Oct 26, 2026

    @huangji6693-max

    Submitted PR #1218 implementing the SDK architecture documentation (ARCHITECTURE.md and docs/ARCHITECTURE_GUIDE.md), Mermaid diagrams (layered architecture, mutating transaction lifecycle, and circuit breaker state machine), ADRs (ADR-001–ADR-006), subpath API surface catalog, 6 extension point guides, and the ArchitectureRegistry validator + unit test suite (test/architectureDocs.test.ts): #1218

  4. ranjan1969x commented on Nov 1, 2026

    @ranjan1969x

    Hello,

    I can take this one on. I'll update the documentation and instructions to accurately reflect the implementation to ensure the documentation has discrepancies with the current codebase is handled cleanly, plus tests to verify all links, code snippets, and build docs cleanly without warnings.

    Looking forward to working on it if assigned!

  5. genZIn4532 commented on Nov 2, 2026

    @genZIn4532

    Hey there,

    I reviewed the issue for Add SDK architecture documentation. The documentation has discrepancies with the current codebase regarding add sdk architecture documentation.

    Proposed Implementation:

    1. Audit the source definitions and identify the exact missing methods, types, or deprecation notices.
    2. Update the documentation files with accurate code signatures, examples, and migration guides.
    3. Verify that all markdown anchors, cross-links, and formatting render cleanly without lint warnings.

    Testing & Verification:
    I will run the documentation / markdown linter and verify all code snippets compile against the current API.

    Could you assign this to me? I can get started on the implementation right away.

  6. hubbuugittuuu commented on Nov 2, 2026

    @hubbuugittuuu

    Hi @Stellar-split team,

    I'd like to help resolve this issue. The documentation has discrepancies with the current codebase regarding add sdk architecture documentation. I plan to audit the source definitions and identify the exact missing methods, types, or deprecation notices and update the documentation files with accurate code signatures, examples, and migration guides, followed by verify that all markdown anchors, cross-links, and formatting render cleanly without lint warnings.

    I'll run the documentation / markdown linter and verify all code snippets compile against the current API to verify everything passes cleanly.

    I'd love to work on this! Please assign it to me and I'll put together a well-tested PR.

  7. GangDev6707 commented on Nov 3, 2026

    @GangDev6707

    Hey everyone,

    I reviewed the issue for Add SDK architecture documentation. The documentation has discrepancies with the current codebase regarding add sdk architecture documentation.

    Proposed Implementation:

    1. Audit the source definitions and identify the exact missing methods, types, or deprecation notices.
    2. Update the documentation files with accurate code signatures, examples, and migration guides.
    3. Verify that all markdown anchors, cross-links, and formatting render cleanly without lint warnings.

    Testing & Verification:
    I will run the documentation / markdown linter and verify all code snippets compile against the current API.

    Ready to implement the patch today once assigned. Thanks!

  8. DeepDev69x3 commented on Nov 6, 2026

    @DeepDev69x3

    Hello team,

    I reviewed the issue for Add SDK architecture documentation. The documentation has discrepancies with the current codebase regarding add sdk architecture documentation.

    Proposed Implementation:

    1. Audit the source definitions and identify the exact missing methods, types, or deprecation notices.
    2. Update the documentation files with accurate code signatures, examples, and migration guides.
    3. Verify that all markdown anchors, cross-links, and formatting render cleanly without lint warnings.

    Testing & Verification:
    I will run the documentation / markdown linter and verify all code snippets compile against the current API.

    Ready to implement the fix and verify edge cases. Please assign it to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions