StepFi-Docs/docs.json at main · StepFi-app/StepFi-Docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
  "name": "StepFi Protocol",
  "description": "Open-source BNPL protocol on Stellar for learners in emerging markets. Credit without banks. Progress without limits.",
  "favicon": "https://stepfi.vercel.app/favicon.png",
  "logo": {
    "light": "https://stepfi.vercel.app/favicon.png",
    "dark": "https://stepfi.vercel.app/favicon.png"
  },
  "editPage": false,
  "theme": {
    "defaultTheme": "dark",
    "primary": "#22C55E",
    "primaryDark": "#22C55E",
    "backgroundDark": "#080F1A"
  },
  "header": {
    "showName": true,
    "showGitHubCard": true,
    "links": [
      { "title": "Landing Page", "href": "https://stepfi.vercel.app" },
      { "title": "API Docs", "href": "https://stepfi-api.onrender.com/api/v1/docs" },
      { "title": "Demo", "href": "https://stepfi.vercel.app/demo" }
    ]
  },
  "social": {
    "github": "StepFi-app/StepFi-Docs"
  },
  "search": {
    "enabled": true
  },
  "sidebar": [
    {
      "pages": [
        { "title": "Overview", "href": "/", "icon": "book" },
        { "title": "Architecture", "href": "/architecture", "icon": "sitemap" },
        { "title": "Quick Start", "href": "/quick-start", "icon": "rocket" }
      ]
    },
    {
      "group": "Protocol",
      "icon": "shield",
      "pages": [
        { "title": "How It Works", "href": "/protocol/how-it-works", "icon": "circle-dot" },
        { "title": "Learner Flow", "href": "/protocol/learner-flow", "icon": "graduation-cap" },
        { "title": "Sponsor Flow", "href": "/protocol/sponsor-flow", "icon": "building-bank" },
        { "title": "Mentor Vouching", "href": "/protocol/mentor-vouching", "icon": "award" },
        { "title": "Reputation System", "href": "/protocol/reputation", "icon": "star" }
      ]
    },
    {
      "group": "Smart Contracts",
      "icon": "code",
      "pages": [
        { "title": "Overview", "href": "/contracts/overview", "icon": "layout-grid" },
        { "title": "Creditline", "href": "/contracts/creditline", "icon": "credit-card" },
        { "title": "Reputation", "href": "/contracts/reputation", "icon": "star" },
        { "title": "Liquidity Pool", "href": "/contracts/liquidity-pool", "icon": "droplet" },
        { "title": "Vendor Registry", "href": "/contracts/vendor-registry", "icon": "building-store" },
        { "title": "Parameters", "href": "/contracts/parameters", "icon": "settings" }
      ]
    },
    {
      "group": "API Reference",
      "icon": "api",
      "pages": [
        { "title": "Overview", "href": "/api/overview", "icon": "layout-grid" },
        { "title": "Authentication", "href": "/api/authentication", "icon": "lock" },
        { "title": "Loans", "href": "/api/loans", "icon": "credit-card" },
        { "title": "Reputation", "href": "/api/reputation", "icon": "star" },
        { "title": "Vendors", "href": "/api/vendors", "icon": "building-store" },
        { "title": "Liquidity", "href": "/api/liquidity", "icon": "droplet" },
        { "title": "Vouching", "href": "/api/vouching", "icon": "award" },
        { "title": "Sponsors", "href": "/api/sponsors", "icon": "building-bank" },
        { "title": "Playground", "href": "/api/playground", "icon": "player-play" }
      ]
    },
    {
      "group": "Mobile App",
      "icon": "device-mobile",
      "pages": [
        { "title": "Overview", "href": "/mobile/overview", "icon": "layout-grid" },
        { "title": "Wallet Connection", "href": "/mobile/wallet-connection", "icon": "wallet" },
        { "title": "Screens", "href": "/mobile/screens", "icon": "device-mobile" }
      ]
    },
    {
      "group": "Contributing",
      "icon": "git-pull-request",
      "pages": [
        { "title": "Overview", "href": "/contributing/overview", "icon": "layout-grid" },
        { "title": "Code Standards", "href": "/contributing/code-standards", "icon": "code" },
        { "title": "Smart Contracts", "href": "/contributing/contracts", "icon": "file-code" },
        { "title": "Backend", "href": "/contributing/backend", "icon": "server" },
        { "title": "Mobile", "href": "/contributing/mobile", "icon": "device-mobile" }
      ]
    }
  ]
}