Skip to content

Commit 5139a2e

Browse files
hajjimohajjimo
authored
docs: mi/3170/overview updates (#3233)
* docs: mi/3170/overview-updates * docs: mi/3170/overview-updates * docs: mi/3170/overview-updates - Updated Expose an exchange rate endpoint to Conditionally Optional - Updated Peers to Required - Fixed typo within Peers section
1 parent 836cff2 commit 5139a2e

File tree

2 files changed

+166
-164
lines changed

2 files changed

+166
-164
lines changed

‎packages/documentation/astro.config.mjs

Lines changed: 149 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -72,206 +72,201 @@ export default defineConfig({
7272
},
7373
sidebar: [
7474
{
75-
label: 'Rafiki Docs',
75+
label: 'Overview',
7676
items: [
7777
{
78-
label: 'Overview',
79-
items: [
80-
{
81-
label: 'Introducing Rafiki',
82-
link: '/overview/overview'
83-
},
84-
{
85-
label: 'Concepts',
86-
collapsed: true,
87-
items: [
88-
{
89-
label: 'Accounting',
90-
link: '/overview/concepts/accounting'
91-
},
92-
{
93-
label: 'Interledger',
94-
link: '/overview/concepts/interledger'
95-
},
96-
{
97-
label: 'Open Payments',
98-
link: '/overview/concepts/open-payments'
99-
},
100-
{
101-
label: 'Telemetry',
102-
link: '/overview/concepts/telemetry'
103-
}
104-
]
105-
}
106-
]
78+
label: 'Introducing Rafiki',
79+
link: '/overview/overview'
10780
},
10881
{
109-
label: 'Integration',
82+
label: 'Concepts',
11083
collapsed: true,
11184
items: [
11285
{
113-
label: 'Requirements',
114-
collapsed: true,
115-
items: [
116-
{
117-
label: 'Overview and checklist',
118-
link: '/integration/requirements/overview'
119-
},
120-
{
121-
label: 'Assets',
122-
link: '/integration/requirements/assets'
123-
},
124-
{
125-
label: 'Peers',
126-
link: '/integration/requirements/peers'
127-
},
128-
{
129-
label: 'Wallet addresses',
130-
link: '/integration/requirements/wallet-addresses'
131-
},
132-
{
133-
label: 'Webhook events',
134-
link: '/integration/requirements/webhook-events'
135-
},
136-
{
137-
label: 'Exchange rates',
138-
link: '/integration/requirements/exchange-rates'
139-
},
140-
{
141-
label: 'Sending fees',
142-
link: '/integration/requirements/sending-fees'
143-
},
144-
{
145-
label: 'Identity provider (IdP)',
146-
link: '/integration/requirements/idp'
147-
}
148-
]
86+
label: 'Accounting',
87+
link: '/overview/concepts/accounting'
14988
},
15089
{
151-
label: 'Test locally',
152-
collapsed: true,
153-
items: [
154-
{
155-
label: 'Local playground',
156-
link: '/integration/playground/overview'
157-
},
158-
{
159-
label: 'Autopeering',
160-
link: '/integration/playground/autopeering'
161-
},
162-
{
163-
label: 'Test network',
164-
link: '/integration/playground/testnet'
165-
}
166-
]
90+
label: 'Interledger',
91+
link: '/overview/concepts/interledger'
16792
},
16893
{
169-
label: 'Deployment',
170-
collapsed: true,
171-
items: [
172-
{
173-
label: 'Services',
174-
collapsed: true,
175-
items: [
176-
{
177-
label: 'Auth service',
178-
link: '/integration/deployment/services/auth-service'
179-
},
180-
{
181-
label: 'Backend service',
182-
link: '/integration/deployment/services/backend-service'
183-
},
184-
{
185-
label: 'Frontend service',
186-
link: '/integration/deployment/services/frontend-service'
187-
},
188-
{
189-
label: 'Token introspection',
190-
link: '/integration/deployment/services/token-introspection'
191-
}
192-
]
193-
},
194-
{
195-
label: 'Docker Compose',
196-
link: '/integration/deployment/docker-compose'
197-
},
198-
{
199-
label: 'Helm and Kubernetes',
200-
link: '/integration/deployment/helm-k8s'
201-
}
202-
]
94+
label: 'Open Payments',
95+
link: '/overview/concepts/open-payments'
96+
},
97+
{
98+
label: 'Telemetry',
99+
link: '/overview/concepts/telemetry'
203100
}
204101
]
205-
},
102+
}
103+
]
104+
},
105+
{
106+
label: 'Integration',
107+
collapsed: true,
108+
items: [
206109
{
207-
label: 'Administration',
110+
label: 'Requirements',
208111
collapsed: true,
209112
items: [
210113
{
211-
label: 'Rafiki Admin',
212-
link: '/admin/admin-user-guide'
114+
label: 'Overview and checklist',
115+
link: '/integration/requirements/overview'
213116
},
214117
{
215-
label: 'Manage liquidity',
216-
link: '/admin/manage-liquidity'
217-
}
218-
]
219-
},
220-
{
221-
label: 'Resources',
222-
collapsed: true,
223-
items: [
118+
label: 'Assets',
119+
link: '/integration/requirements/assets'
120+
},
224121
{
225-
label: 'Releases',
226-
link: '/resources/releases'
122+
label: 'Peers',
123+
link: '/integration/requirements/peers'
227124
},
228125
{
229-
label: 'Glossary',
230-
link: '/resources/glossary'
126+
label: 'Wallet addresses',
127+
link: '/integration/requirements/wallet-addresses'
231128
},
232129
{
233-
label: 'Architecture',
234-
link: '/resources/architecture'
130+
label: 'Webhook events',
131+
link: '/integration/requirements/webhook-events'
235132
},
236133
{
237-
label: 'Environment variables',
238-
link: '/resources/environment-variables'
134+
label: 'Exchange rates',
135+
link: '/integration/requirements/exchange-rates'
239136
},
240137
{
241-
label: 'Webhook event types',
242-
link: '/resources/webhook-event-types'
138+
label: 'Sending fees',
139+
link: '/integration/requirements/sending-fees'
243140
},
244141
{
245-
label: 'Get involved',
246-
link: '/resources/get-involved'
142+
label: 'Identity provider (IdP)',
143+
link: '/integration/requirements/idp'
247144
}
248145
]
249146
},
250147
{
251-
label: 'APIs',
148+
label: 'Test locally',
252149
collapsed: true,
253150
items: [
254151
{
255-
label: 'GraphQL Admin APIs',
256-
link: '/apis/graphql/admin-api-overview'
152+
label: 'Local playground',
153+
link: '/integration/playground/overview'
257154
},
258155
{
259-
label: 'Backend Admin API',
260-
collapsed: true,
261-
autogenerate: {
262-
directory: 'apis/graphql/backend'
263-
}
156+
label: 'Autopeering',
157+
link: '/integration/playground/autopeering'
264158
},
265159
{
266-
label: 'Auth Admin API',
160+
label: 'Test network',
161+
link: '/integration/playground/testnet'
162+
}
163+
]
164+
},
165+
{
166+
label: 'Deployment',
167+
collapsed: true,
168+
items: [
169+
{
170+
label: 'Services',
267171
collapsed: true,
268-
autogenerate: {
269-
directory: 'apis/graphql/auth'
270-
}
172+
items: [
173+
{
174+
label: 'Auth service',
175+
link: '/integration/deployment/services/auth-service'
176+
},
177+
{
178+
label: 'Backend service',
179+
link: '/integration/deployment/services/backend-service'
180+
},
181+
{
182+
label: 'Frontend service',
183+
link: '/integration/deployment/services/frontend-service'
184+
},
185+
{
186+
label: 'Token introspection',
187+
link: '/integration/deployment/services/token-introspection'
188+
}
189+
]
190+
},
191+
{
192+
label: 'Docker Compose',
193+
link: '/integration/deployment/docker-compose'
194+
},
195+
{
196+
label: 'Helm and Kubernetes',
197+
link: '/integration/deployment/helm-k8s'
271198
}
272199
]
273200
}
274201
]
202+
},
203+
{
204+
label: 'Administration',
205+
collapsed: true,
206+
items: [
207+
{
208+
label: 'Rafiki Admin',
209+
link: '/admin/admin-user-guide'
210+
},
211+
{
212+
label: 'Manage liquidity',
213+
link: '/admin/manage-liquidity'
214+
}
215+
]
216+
},
217+
{
218+
label: 'Resources',
219+
collapsed: true,
220+
items: [
221+
{
222+
label: 'Releases',
223+
link: '/resources/releases'
224+
},
225+
{
226+
label: 'Glossary',
227+
link: '/resources/glossary'
228+
},
229+
{
230+
label: 'Architecture',
231+
link: '/resources/architecture'
232+
},
233+
{
234+
label: 'Environment variables',
235+
link: '/resources/environment-variables'
236+
},
237+
{
238+
label: 'Webhook event types',
239+
link: '/resources/webhook-event-types'
240+
},
241+
{
242+
label: 'Get involved',
243+
link: '/resources/get-involved'
244+
}
245+
]
246+
},
247+
{
248+
label: 'APIs',
249+
collapsed: true,
250+
items: [
251+
{
252+
label: 'GraphQL Admin APIs',
253+
link: '/apis/graphql/admin-api-overview'
254+
},
255+
{
256+
label: 'Backend Admin API',
257+
collapsed: true,
258+
autogenerate: {
259+
directory: 'apis/graphql/backend'
260+
}
261+
},
262+
{
263+
label: 'Auth Admin API',
264+
collapsed: true,
265+
autogenerate: {
266+
directory: 'apis/graphql/auth'
267+
}
268+
}
269+
]
275270
}
276271
],
277272
plugins: [

0 commit comments

Comments
 (0)