docs/docs.jsonc at main · Mesub-io/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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
{
  "$schema": "https://holocron.so/docs.json",
  "name": "Mesub - Docs",
  "logo": { "light": "/logo.svg", "dark": "/logo-dark.svg", "href": "https://mesub.io" },
  "description": "Documentation for Mesub, recurring payments on Solana.",
  "favicon": "/icon.png",
  "colors": {
    // The same orange in both themes: left alone, dark mode washes it to pink.
    "primary": "#f46036",
    "light": "#f46036",
    "dark": "#f46036"
  },
  "icons": {
    "library": "lucide"
  },
  // The pill at the bottom, so the right column of a reference page starts with its samples.
  // Room for the reference's two columns: parameters, then samples.
  "layout": { "maxWidth": 1320 },
  "navbar": {
    "primary": { "type": "button", "label": "Dashboard", "href": "https://mesub.io/dashboard" }
  },
  "navigation": {
    "tabs": [
      {
        "tab": "Guides",
        "icon": "lucide:book-open",
        "groups": [
          {
            "group": "Get started",
            "icon": "lucide:rocket",
            "pages": ["index", "docs/quickstart", "docs/how-it-works", "docs/api-key"]
          },
          {
            "group": "Access and status",
            "icon": "lucide:lock-keyhole",
            "pages": ["docs/access", "docs/lifecycle", "docs/webhooks"]
          },
          {
            "group": "Subscribe and manage",
            "icon": "lucide:repeat",
            "pages": ["docs/react", "docs/subscribe", "docs/manage"]
          },
          {
            "group": "Go live",
            "icon": "lucide:send",
            "pages": ["docs/testing", "docs/pricing"]
          },
          {
            "group": "AI",
            "icon": "lucide:bot",
            "pages": ["docs/mcp", "docs/skills"]
          }
        ]
      },
      {
        // Every page below "Overview" is written by scripts/reference.mjs from
        // public/openapi.json. A new route goes in the spec, then here.
        "tab": "API reference",
        "icon": "lucide:braces",
        "groups": [
          {
            "group": "Overview",
            "pages": ["reference/introduction", "reference/authentication", "reference/errors"]
          },
          {
            // Nested groups fold: only the one holding the current page is open.
            "group": "Endpoints",
            "pages": [
              {
                "group": "Access",
                "pages": ["reference/access/check"]
              },
              {
                "group": "Plans",
                "pages": ["reference/plans/list", "reference/plans/retrieve"]
              },
              {
                "group": "Subscriptions",
                "pages": [
                  "reference/subscriptions/object",
                  "reference/subscriptions/create",
                  "reference/subscriptions/transaction",
                  "reference/subscriptions/submit",
                  "reference/subscriptions/list",
                  "reference/subscriptions/retrieve",
                  "reference/subscriptions/attempts"
                ]
              },
              {
                "group": "Cancel, resume, close",
                "pages": [
                  "reference/manage/cancel",
                  "reference/manage/confirm-cancel",
                  "reference/manage/resume",
                  "reference/manage/confirm-resume",
                  "reference/manage/close",
                  "reference/manage/confirm-close"
                ]
              },
              {
                "group": "Project",
                "pages": ["reference/project/retrieve"]
              }
            ]
          },
          {
            "group": "Webhooks",
            "pages": [
              "reference/webhooks/overview",
              {
                "group": "Events",
                "pages": [
                  "reference/webhooks/subscription-created",
                  "reference/webhooks/subscription-renewal-upcoming",
                  "reference/webhooks/subscription-renewed",
                  "reference/webhooks/subscription-payment-failed",
                  "reference/webhooks/subscription-stopped",
                  "reference/webhooks/subscription-cancelled",
                  "reference/webhooks/subscription-resumed",
                  "reference/webhooks/subscription-ended",
                  "reference/webhooks/subscription-expired",
                  "reference/webhooks/test"
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "redirects": [
    // The single API page became the reference tab.
    { "source": "/docs/api", "destination": "/reference/introduction", "permanent": true }
  ]
}