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.
📖 Read the docs: https://docs.page/StepFi-app/StepFi-Docs
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.
StepFi-Docs is the reference layer that documents every other repository in the protocol — the contracts, the API, and the clients.
Content lives in docs/ as MDX, with the site structure and navigation defined in 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) |
The site is rendered directly from this repository by docs.page — there is no build step or generated output to commit.
- Edit or add an
.mdxfile underdocs/. - If you add, remove, or move a page, update its entry in
docs.jsonso it appears in the sidebar. - 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.jsonformat — it is not a Mintlify site, so don't reach for the Mintlify CLI.
Every push and PR runs .github/workflows/ci.yml, which executes .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.
| Repo | Role |
|---|---|
| StepFi-Docs (this repo) | Protocol documentation |
| StepFi-Contracts | Soroban smart contracts (credit, reputation, liquidity) |
| StepFi-API | Backend — auth/JWT, orchestration, jobs |
| StepFi-App | Learner mobile client (Expo / React Native) |
| StepFi-Web | Sponsor / vendor / mentor web app |