Skip to content

docs: switch the ordering of quickstart docs #167

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

Merged
Benzilla merged 1 commit into from
Sep 22, 2026
Merged

docs: switch the ordering of quickstart docs #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions apps/docs/scripts/generate-agent-docs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ test('agent guides use a dedicated final sidebar section', () => {
assert.deepEqual(
getStarted?.children?.map((child) => child.id),
[
'quickstart',
'api-quickstart',
'payment-link-quickstart',
'checkout-api-quickstart',
'authentication',
'migrate-from-stripe',
'platform-dashboard',
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/app/pages/docs/data/api-quickstart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { NODE_INIT } from './shared';

export const CHECKOUT_API_QUICKSTART_PAGE: DocPage = {
id: 'checkout-api-quickstart',
title: 'Checkout API quickstart',
title: 'API Quickstart',
description:
'Accept USDC payments from your app with Checkout and the Zoneless Node.js SDK. This guide uses Zoneless Cloud in live mode.',
sections: [
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/app/pages/docs/data/build-a-marketplace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { DocPage } from './types';

export const API_QUICKSTART_PAGE: DocPage = {
id: 'api-quickstart',
title: 'API Quickstart',
title: 'Payouts API Quickstart',
description:
'Create a connected account, onboard a seller, and send their first USDC payout.',
sections: [
Expand Down
32 changes: 12 additions & 20 deletions apps/docs/src/app/pages/docs/data/guides.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,16 @@ export const GET_STARTED_SECTION: DocSection = {
id: 'get-started',
title: 'Get started',
children: [
{ id: 'quickstart', title: 'Quickstart', children: [] },
{ id: 'api-quickstart', title: 'API Quickstart', children: [] },
{
id: 'payment-link-quickstart',
title: 'Quickstart',
children: [],
},
{
id: 'checkout-api-quickstart',
title: 'API Quickstart',
children: [],
},
{ id: 'authentication', title: 'Authentication', children: [] },
{ id: 'migrate-from-stripe', title: 'Migrate from Stripe', children: [] },
{ id: 'platform-dashboard', title: 'Platform Dashboard', children: [] },
Expand All @@ -31,6 +39,8 @@ export const CONNECT_GUIDES_SECTION: DocSection = {
id: 'connect-guides',
title: 'Marketplaces',
children: [
{ id: 'quickstart', title: 'Payouts Quickstart', children: [] },
{ id: 'api-quickstart', title: 'Payouts API Quickstart', children: [] },
{ id: 'connected-accounts', title: 'Connected Accounts', children: [] },
{
id: 'fund-platform-wallet',
Expand All @@ -45,23 +55,6 @@ export const CONNECT_GUIDES_SECTION: DocSection = {
],
};

export const PAYMENTS_GUIDES_SECTION: DocSection = {
id: 'payments-guides',
title: 'Payments',
children: [
{
id: 'payment-link-quickstart',
title: 'Payment Links quickstart',
children: [],
},
{
id: 'checkout-api-quickstart',
title: 'Checkout API quickstart',
children: [],
},
],
};

export const DEVELOPMENT_SECTION: DocSection = {
id: 'development',
title: 'Development',
Expand Down Expand Up @@ -97,7 +90,6 @@ export const PRIMARY_GUIDE_SECTIONS: DocSection[] = [
CONNECT_GUIDES_SECTION,
SELF_HOSTING_SECTION,
DEVELOPMENT_SECTION,
PAYMENTS_GUIDES_SECTION,
];

export const GUIDE_SECTIONS: DocSection[] = [
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/app/pages/docs/data/marketplace-quickstart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { DocPage } from './types';

export const QUICKSTART_PAGE: DocPage = {
id: 'quickstart',
title: 'Quickstart',
title: 'Payouts Quickstart',
description:
'Onboard a seller and send their first USDC payout with no code.',
sections: [
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/app/pages/docs/data/quickstart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { DocPage } from './types';

export const PAYMENT_LINK_QUICKSTART_PAGE: DocPage = {
id: 'payment-link-quickstart',
title: 'Payment Links quickstart',
title: 'Quickstart',
description: 'Accept your first stablecoin payment with no code.',
sections: [
{
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/src/app/pages/docs/docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export class Docs implements OnInit, OnDestroy, AfterViewInit {
readonly agentMarketplacePrompt = marketplaceAgentPrompt;
readonly agentPaymentsPrompt = paymentsAgentPrompt;

activeSection = signal<string>('quickstart');
activeSection = signal<string>('payment-link-quickstart');
activeSubSection = signal<string>('');
expandedSections = signal<Set<string>>(
new Set(docSections.map((section) => section.id))
Expand Down
Loading