diff --git a/README.md b/README.md new file mode 100644 index 0000000..87f6740 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +
+ +# StepFi-Docs + +**The protocol documentation for StepFi β€” reputation-based, collateral-light credit on Stellar.** + +Guides, contract references, API references, and contributor docs for the whole StepFi protocol, published with [docs.page](https://docs.page). + +[![CI](https://github.com/StepFi-app/StepFi-Docs/actions/workflows/ci.yml/badge.svg)](https://github.com/StepFi-app/StepFi-Docs/actions/workflows/ci.yml) +[![Docs](https://img.shields.io/badge/docs-live-22C55E.svg)](https://docs.page/StepFi-app/StepFi-Docs) +[![Stellar](https://img.shields.io/badge/Stellar-Soroban-7D00FF?logo=stellar&logoColor=white)](https://stellar.org) + +**πŸ“– Read the docs:** https://docs.page/StepFi-app/StepFi-Docs + +
+ +--- + +## πŸ“– What is this? + +StepFi lets learners and interns borrow small amounts against an **on-chain reputation score** instead of collateral, repay in installments, and build credit β€” while sponsors fund a shared liquidity pool, vendors get paid directly, and mentors vouch to boost reputation. This repository is the **documentation** for that protocol: how it works, every smart contract, every API surface, the mobile client, and how to contribute. + +## πŸ—ΊοΈ Where it fits + +
+ +StepFi system architecture β€” StepFi-Docs highlighted + +
+ +StepFi-Docs is the reference layer that documents every other repository in the protocol β€” the contracts, the API, and the clients. + +## 🧭 What's inside + +Content lives in [`docs/`](docs) as MDX, with the site structure and navigation defined in [`docs.json`](docs.json): + +| Section | Covers | +|---------|--------| +| **Overview Β· Architecture Β· Quick Start** | Protocol intro, system architecture, getting started | +| **Protocol** | How it works, learner flow, sponsor flow, mentor vouching, the reputation system | +| **Smart Contracts** | Creditline, Reputation, Liquidity Pool, Vendor Registry, Parameters | +| **API** | Authentication, loans, liquidity, sponsors, vendors, reputation, vouching, the playground | +| **Mobile** | App overview, screens, wallet connection | +| **Contributing** | Contribution overview and per-area guides (backend, contracts, mobile, code standards) | + +## ✍️ Editing the docs + +The site is rendered directly from this repository by **docs.page** β€” there is no build step or generated output to commit. + +1. Edit or add an `.mdx` file under [`docs/`](docs). +2. If you add, remove, or move a page, update its entry in [`docs.json`](docs.json) so it appears in the sidebar. +3. Open a PR. docs.page serves a preview for your branch/PR, and the changes go live at the URL above once merged to `main`. + +> Note: this project uses docs.page's `docs.json` format β€” it is **not** a Mintlify site, so don't reach for the Mintlify CLI. + +## πŸ”„ CI + +Every push and PR runs [`.github/workflows/ci.yml`](.github/workflows/ci.yml), which executes [`.github/scripts/validate-docs.mjs`](.github/scripts/validate-docs.mjs) to validate `docs.json` and check that every sidebar link resolves to a real page. Keep it green β€” broken links fail the build. + +## 🌐 The StepFi protocol + +| Repo | Role | +|------|------| +| **StepFi-Docs** (this repo) | Protocol documentation | +| [StepFi-Contracts](https://github.com/StepFi-app/StepFi-Contracts) | Soroban smart contracts (credit, reputation, liquidity) | +| [StepFi-API](https://github.com/StepFi-app/StepFi-API) | Backend β€” auth/JWT, orchestration, jobs | +| [StepFi-App](https://github.com/StepFi-app/StepFi-App) | Learner mobile client (Expo / React Native) | +| [StepFi-Web](https://github.com/StepFi-app/StepFi-Web) | Sponsor / vendor / mentor web app | diff --git a/architecture.svg b/architecture.svg new file mode 100644 index 0000000..4e06057 --- /dev/null +++ b/architecture.svg @@ -0,0 +1,115 @@ + + + + + + + + + + + + + StepFi β€” System Architecture + Reputation-based micro-credit for students & small vendors, settled on Stellar + + + + + + πŸ“š StepFi-Docs + Protocol documentation + + + USERS + + + + + + πŸŽ“ Learners + πŸ’š Sponsors + πŸͺ Vendors + + + CLIENTS + + + + + πŸ“± StepFi-App + Expo Β· React Native + learner & sponsor mobile client + 🌐 StepFi-Web + marketing site & + web dashboard + + + WALLETS + + + + πŸ” Wallets + Freighter (web) Β· Lobstr (mobile) + via WalletConnect Β· sign XDR / message + + + BACKEND + + + + βš™οΈ StepFi-API + NestJS backend Β· REST + + + πŸ”‘ Auth Β· JWT + + πŸ”— Orchestration + + ⏱ Jobs + + + + + + + + + + sign + REST Β· JWT + + + + + + ✦ Stellar Network β€” Soroban platform (testnet) Β· StepFi-Contracts + + + + + + + Creditline + Reputation + Liquidity Pool + Vendor Registry + Parameters + + + loans & repayment + score & tiers + sponsor funds + verified merchants + governance Β· multisig + + + + + + + + Soroban RPC + submit signed XDR + this repo +