Repository navigation
docs: overhaul README with architecture diagram and protocol guide - #116
Merged
Merged
Conversation
…uide Rewrite the README into a standard, detailed guide: what StepFi is and where the contracts fit, a per-contract responsibility table, the score-based credit model (APR/limit brackets), contract-interaction overview, canonical testnet addresses with explorer links, security & governance summary, build/test instructions with per-crate test counts, CI/CD and roadmap. Add an embedded SVG architecture diagram and an MIT LICENSE. The contributor-leaderboard block and its markers are preserved so the leaderboard workflow keeps updating.
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
Rewrites the README into a standard, detailed protocol guide and adds an embedded system-architecture diagram showing where the contracts sit in StepFi (clients/API → contracts on Stellar). Adds a per-contract responsibility table, the score→APR→limit credit model, canonical testnet addresses with explorer links, a security/governance summary, per-crate test counts, and a roadmap. The contributor-leaderboard block and its
LEADERBOARD_START/ENDmarkers are preserved so the leaderboard workflow keeps working. Adds an MITLICENSE.Docs/assets only — no contract code changed.
Type of change
Testing
cargo buildunaffected (no Rust changed) — verified by CIcargo testunaffected — verified by CINotes
docs/architecture.svg(hand-authored, GitHub-rendered).