Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mi/3170/overview updates #3233

Merged
merged 3 commits into from
Jan 22, 2025
Merged

docs: mi/3170/overview updates #3233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
244a958
docs: mi/3170/overview-updates
hajjimo Jan 21, 2025
b2a34f8
docs: mi/3170/overview-updates
hajjimo Jan 21, 2025
30aa3fa
docs: mi/3170/overview-updates
hajjimo Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
303 changes: 149 additions & 154 deletions packages/documentation/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,206 +72,201 @@ export default defineConfig({
},
sidebar: [
{
label: 'Rafiki Docs',
label: 'Overview',
items: [
{
label: 'Overview',
items: [
{
label: 'Introducing Rafiki',
link: '/overview/overview'
},
{
label: 'Concepts',
collapsed: true,
items: [
{
label: 'Accounting',
link: '/overview/concepts/accounting'
},
{
label: 'Interledger',
link: '/overview/concepts/interledger'
},
{
label: 'Open Payments',
link: '/overview/concepts/open-payments'
},
{
label: 'Telemetry',
link: '/overview/concepts/telemetry'
}
]
}
]
label: 'Introducing Rafiki',
link: '/overview/overview'
},
{
label: 'Integration',
label: 'Concepts',
collapsed: true,
items: [
{
label: 'Requirements',
collapsed: true,
items: [
{
label: 'Overview and checklist',
link: '/integration/requirements/overview'
},
{
label: 'Assets',
link: '/integration/requirements/assets'
},
{
label: 'Peers',
link: '/integration/requirements/peers'
},
{
label: 'Wallet addresses',
link: '/integration/requirements/wallet-addresses'
},
{
label: 'Webhook events',
link: '/integration/requirements/webhook-events'
},
{
label: 'Exchange rates',
link: '/integration/requirements/exchange-rates'
},
{
label: 'Sending fees',
link: '/integration/requirements/sending-fees'
},
{
label: 'Identity provider (IdP)',
link: '/integration/requirements/idp'
}
]
label: 'Accounting',
link: '/overview/concepts/accounting'
},
{
label: 'Test locally',
collapsed: true,
items: [
{
label: 'Local playground',
link: '/integration/playground/overview'
},
{
label: 'Autopeering',
link: '/integration/playground/autopeering'
},
{
label: 'Test network',
link: '/integration/playground/testnet'
}
]
label: 'Interledger',
link: '/overview/concepts/interledger'
},
{
label: 'Deployment',
collapsed: true,
items: [
{
label: 'Services',
collapsed: true,
items: [
{
label: 'Auth service',
link: '/integration/deployment/services/auth-service'
},
{
label: 'Backend service',
link: '/integration/deployment/services/backend-service'
},
{
label: 'Frontend service',
link: '/integration/deployment/services/frontend-service'
},
{
label: 'Token introspection',
link: '/integration/deployment/services/token-introspection'
}
]
},
{
label: 'Docker Compose',
link: '/integration/deployment/docker-compose'
},
{
label: 'Helm and Kubernetes',
link: '/integration/deployment/helm-k8s'
}
]
label: 'Open Payments',
link: '/overview/concepts/open-payments'
},
{
label: 'Telemetry',
link: '/overview/concepts/telemetry'
}
]
},
}
]
},
{
label: 'Integration',
collapsed: true,
items: [
{
label: 'Administration',
label: 'Requirements',
collapsed: true,
items: [
{
label: 'Rafiki Admin',
link: '/admin/admin-user-guide'
label: 'Overview and checklist',
link: '/integration/requirements/overview'
},
{
label: 'Manage liquidity',
link: '/admin/manage-liquidity'
}
]
},
{
label: 'Resources',
collapsed: true,
items: [
label: 'Assets',
link: '/integration/requirements/assets'
},
{
label: 'Releases',
link: '/resources/releases'
label: 'Peers',
link: '/integration/requirements/peers'
},
{
label: 'Glossary',
link: '/resources/glossary'
label: 'Wallet addresses',
link: '/integration/requirements/wallet-addresses'
},
{
label: 'Architecture',
link: '/resources/architecture'
label: 'Webhook events',
link: '/integration/requirements/webhook-events'
},
{
label: 'Environment variables',
link: '/resources/environment-variables'
label: 'Exchange rates',
link: '/integration/requirements/exchange-rates'
},
{
label: 'Webhook event types',
link: '/resources/webhook-event-types'
label: 'Sending fees',
link: '/integration/requirements/sending-fees'
},
{
label: 'Get involved',
link: '/resources/get-involved'
label: 'Identity provider (IdP)',
link: '/integration/requirements/idp'
}
]
},
{
label: 'APIs',
label: 'Test locally',
collapsed: true,
items: [
{
label: 'GraphQL Admin APIs',
link: '/apis/graphql/admin-api-overview'
label: 'Local playground',
link: '/integration/playground/overview'
},
{
label: 'Backend Admin API',
collapsed: true,
autogenerate: {
directory: 'apis/graphql/backend'
}
label: 'Autopeering',
link: '/integration/playground/autopeering'
},
{
label: 'Auth Admin API',
label: 'Test network',
link: '/integration/playground/testnet'
}
]
},
{
label: 'Deployment',
collapsed: true,
items: [
{
label: 'Services',
collapsed: true,
autogenerate: {
directory: 'apis/graphql/auth'
}
items: [
{
label: 'Auth service',
link: '/integration/deployment/services/auth-service'
},
{
label: 'Backend service',
link: '/integration/deployment/services/backend-service'
},
{
label: 'Frontend service',
link: '/integration/deployment/services/frontend-service'
},
{
label: 'Token introspection',
link: '/integration/deployment/services/token-introspection'
}
]
},
{
label: 'Docker Compose',
link: '/integration/deployment/docker-compose'
},
{
label: 'Helm and Kubernetes',
link: '/integration/deployment/helm-k8s'
}
]
}
]
},
{
label: 'Administration',
collapsed: true,
items: [
{
label: 'Rafiki Admin',
link: '/admin/admin-user-guide'
},
{
label: 'Manage liquidity',
link: '/admin/manage-liquidity'
}
]
},
{
label: 'Resources',
collapsed: true,
items: [
{
label: 'Releases',
link: '/resources/releases'
},
{
label: 'Glossary',
link: '/resources/glossary'
},
{
label: 'Architecture',
link: '/resources/architecture'
},
{
label: 'Environment variables',
link: '/resources/environment-variables'
},
{
label: 'Webhook event types',
link: '/resources/webhook-event-types'
},
{
label: 'Get involved',
link: '/resources/get-involved'
}
]
},
{
label: 'APIs',
collapsed: true,
items: [
{
label: 'GraphQL Admin APIs',
link: '/apis/graphql/admin-api-overview'
},
{
label: 'Backend Admin API',
collapsed: true,
autogenerate: {
directory: 'apis/graphql/backend'
}
},
{
label: 'Auth Admin API',
collapsed: true,
autogenerate: {
directory: 'apis/graphql/auth'
}
}
]
}
],
plugins: [
Expand Down
Loading
Loading