Add architectural documentation for Pi Ruby SDK #37
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
This PR adds a new documentation file:
docs/architecture-notes.md.The document provides architectural notes and design context for the Pi Ruby SDK,
helping developers understand system boundaries, responsibilities, and intended
usage patterns.
Motivation
While the SDK API is well-documented, there is limited high-level explanation
of why the payment flow is structured as it is and where the SDK fits
within the broader Pi Network architecture.
This document aims to improve developer understanding without introducing
new functionality or changing existing behavior.
Scope of Changes
docs/architecture-notes.mdKey Topics Covered
Notes
This document is descriptive only and does not represent an official roadmap
or future commitments. All content aligns with existing SDK behavior and
current Pi Network application guidelines.