Skip to content

Commit 7c7fcc0

Browse files
[Documentation] Refactor: Reorganize Connect sidebar and simplify guides
1 parent b4eed8a commit 7c7fcc0

File tree

7 files changed

+101
-267
lines changed

7 files changed

+101
-267
lines changed

apps/portal/src/app/connect/sidebar.tsx

Lines changed: 99 additions & 176 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
import type { SideBar } from "@/components/Layouts/DocLayout";
2-
import {
3-
DotNetIcon,
4-
PayIcon,
5-
ReactIcon,
6-
TypeScriptIcon,
7-
UnityIcon,
8-
WalletsAuthIcon,
9-
WalletsInAppIcon,
10-
WalletsSmartIcon,
11-
} from "@/icons";
12-
import { CodeIcon, ExternalLink, ZapIcon } from "lucide-react";
2+
import { DotNetIcon, ReactIcon, TypeScriptIcon, UnityIcon } from "@/icons";
3+
import { ExternalLink, ZapIcon } from "lucide-react";
134
import { UnrealEngineIcon } from "../../icons/sdks/UnrealEngineIcon";
145

156
// TODO: move the following two slugs to walletSlug with updated docs
@@ -49,150 +40,99 @@ export const sidebar: SideBar = {
4940
icon: <ExternalLink />,
5041
},
5142
{ separator: true },
43+
// Connect\
5244
{
53-
name: "Learn",
45+
name: "Onboard Users",
46+
expanded: true,
5447
isCollapsible: false,
5548
links: [
56-
// Connect\
5749
{
58-
name: "Wallets",
59-
icon: <WalletsInAppIcon />,
50+
name: "Overview",
51+
href: `${walletSlug}/overview`,
52+
},
53+
{
54+
name: "Security",
55+
href: `${walletSlug}/security`,
56+
},
57+
{
58+
name: "Get Started",
59+
href: `${walletSlug}/get-started`,
60+
},
61+
{
62+
name: "External Wallets",
63+
href: `${walletSlug}/sign-in-methods/external-wallets`,
64+
},
65+
{
66+
name: "In-App Wallets",
6067
links: [
6168
{
62-
name: "Overview",
63-
href: `${walletSlug}/overview`,
64-
},
65-
{
66-
name: "Security",
67-
href: `${walletSlug}/security`,
68-
},
69-
{
70-
name: "Get Started",
71-
href: `${walletSlug}/get-started`,
69+
name: "Sign-In Methods",
70+
href: `${walletSlug}/sign-in-methods/configure`,
7271
},
73-
7472
{
7573
name: "Pregenerate Wallets",
7674
href: `${walletSlug}/pregenerate-wallets`,
7775
},
7876
{
79-
name: "Sign-In Methods",
77+
name: "Guest Mode",
78+
href: `${walletSlug}/sign-in-methods/guest`,
79+
},
80+
{
81+
name: "Custom Authentication",
8082
links: [
8183
{
82-
name: "Configure",
83-
href: `${walletSlug}/sign-in-methods/configure`,
84+
name: "Overview",
85+
href: `${inAppSlug}/custom-auth/overview`,
8486
},
8587
{
86-
name: "Guest Mode",
87-
href: `${walletSlug}/sign-in-methods/guest`,
88+
name: "Configuration",
89+
href: `${inAppSlug}/custom-auth/configuration`,
8890
},
8991
{
90-
name: "External Wallets",
91-
href: `${walletSlug}/sign-in-methods/external-wallets`,
92-
},
93-
{
94-
name: "Custom Authentication",
92+
name: "Integration guides",
9593
links: [
9694
{
97-
name: "Overview",
98-
href: `${inAppSlug}/custom-auth/overview`,
95+
name: "Custom auth server (OIDC Auth)",
96+
href: `${inAppSlug}/custom-auth/custom-jwt-auth-server`,
9997
},
10098
{
101-
name: "Configuration",
102-
href: `${inAppSlug}/custom-auth/configuration`,
99+
name: "Custom auth server (Generic Auth)",
100+
href: `${inAppSlug}/custom-auth/custom-auth-server`,
103101
},
104102
{
105-
name: "Integration guides",
106-
links: [
107-
{
108-
name: "Custom auth server (OIDC Auth)",
109-
href: `${inAppSlug}/custom-auth/custom-jwt-auth-server`,
110-
},
111-
{
112-
name: "Custom auth server (Generic Auth)",
113-
href: `${inAppSlug}/custom-auth/custom-auth-server`,
114-
},
115-
{
116-
name: "Firebase Auth",
117-
href: `${inAppSlug}/custom-auth/firebase-auth`,
118-
},
119-
],
103+
name: "Firebase Auth",
104+
href: `${inAppSlug}/custom-auth/firebase-auth`,
120105
},
121106
],
122107
},
123108
],
124109
},
125-
126-
{
127-
name: "User Management",
128-
links: [
129-
{
130-
name: "Get User Profiles",
131-
href: `${walletSlug}/user-management/get-user-profiles`,
132-
},
133-
{
134-
name: "Export Private Keys",
135-
href: `${walletSlug}/user-management/export-private-key`,
136-
},
137-
{
138-
name: "Link Multiple Identity",
139-
href: `${walletSlug}/user-management/link-multiple-identity`,
140-
},
141-
// TODO:
142-
// {
143-
// name: "Deleting User Details",
144-
// href: `${walletSlug}/user-management/deleting-user-details`,
145-
// },
146-
],
147-
},
110+
],
111+
},
112+
{
113+
name: "Ecosystem Wallets",
114+
links: [
148115
{
149-
name: "Customization",
150-
links: [
151-
{
152-
name: "Prebuilt UI",
153-
href: `${connectSlug}/customization`,
154-
},
155-
// {
156-
// name: "Emails and SMS",
157-
// href: `${connectSlug}/customization#compact-modal`,
158-
// },
159-
],
116+
name: "Set-up",
117+
href: `${walletSlug}/ecosystem/set-up`,
160118
},
161119
{
162-
name: "Ecosystem",
163-
links: [
164-
{
165-
name: "Set-up",
166-
href: `${walletSlug}/ecosystem/set-up`,
167-
},
168-
{
169-
name: "Ecosystem Portal",
170-
href: `${walletSlug}/ecosystem/portal`,
171-
},
172-
{
173-
name: "Managing Ecosystem Permissions",
174-
href: `${walletSlug}/ecosystem/permissions`,
175-
},
176-
{
177-
name: "Integrating with Partners",
178-
href: `${walletSlug}/ecosystem/integrating-partners`,
179-
},
180-
],
120+
name: "Ecosystem Portal",
121+
href: `${walletSlug}/ecosystem/portal`,
181122
},
182123
{
183-
name: "Migrate to thirdweb",
184-
href: `${walletSlug}/migrate-to-thirdweb`,
124+
name: "Managing Ecosystem Permissions",
125+
href: `${walletSlug}/ecosystem/permissions`,
185126
},
186127
{
187-
name: "FAQ",
188-
href: `${walletSlug}/faq`,
128+
name: "Integrating with Partners",
129+
href: `${walletSlug}/ecosystem/integrating-partners`,
189130
},
190131
],
191132
},
192133
//Account abstraction
193134
{
194135
name: "Account Abstraction",
195-
icon: <WalletsSmartIcon />,
196136
links: [
197137
{
198138
name: "Overview",
@@ -245,24 +185,6 @@ export const sidebar: SideBar = {
245185
name: "Sponsorship rules",
246186
href: `${aAslug}/sponsorship-rules`,
247187
},
248-
{
249-
name: "Gasless",
250-
isCollapsible: true,
251-
links: [
252-
{
253-
name: "Engine",
254-
href: `${aAslug}/gasless/engine`,
255-
},
256-
{
257-
name: "Biconomy",
258-
href: `${aAslug}/gasless/biconomy`,
259-
},
260-
{
261-
name: "OpenZeppelin",
262-
href: `${aAslug}/gasless/openzeppelin`,
263-
},
264-
],
265-
},
266188
// {
267189
// name: "References",
268190
// isCollapsible: true,
@@ -292,10 +214,26 @@ export const sidebar: SideBar = {
292214
},
293215
],
294216
},
217+
{
218+
name: "Migrate to thirdweb",
219+
href: `${walletSlug}/migrate-to-thirdweb`,
220+
},
221+
{
222+
name: "FAQ",
223+
href: `${walletSlug}/faq`,
224+
},
225+
],
226+
},
227+
{ separator: true },
228+
// User identity
229+
{
230+
name: "User Identity",
231+
isCollapsible: false,
232+
links: [
295233
// Auth
234+
// TODO move to TS reference
296235
{
297-
name: "Auth (SIWE)",
298-
icon: <WalletsAuthIcon />,
236+
name: "Sign In with Ethereum",
299237
links: [
300238
{
301239
name: "Get Started",
@@ -322,10 +260,35 @@ export const sidebar: SideBar = {
322260
},
323261
],
324262
},
263+
{
264+
name: "Get User Profiles",
265+
href: `${walletSlug}/user-management/get-user-profiles`,
266+
},
267+
{
268+
name: "Link Multiple Identities",
269+
href: `${walletSlug}/user-management/link-multiple-identity`,
270+
},
271+
{
272+
name: "Export Private Keys",
273+
href: `${walletSlug}/user-management/export-private-key`,
274+
},
275+
// TODO:
276+
// {
277+
// name: "Deleting User Details",
278+
// href: `${walletSlug}/user-management/deleting-user-details`,
279+
// },
280+
],
281+
},
282+
{ separator: true },
283+
// Blockchain API
284+
// TODO Overview page?
285+
{
286+
name: "Onchain Interactions",
287+
isCollapsible: false,
288+
links: [
325289
// Pay
326290
{
327-
name: "Pay",
328-
icon: <PayIcon />,
291+
name: "Bridge & Swap",
329292
links: [
330293
{
331294
name: "Overview",
@@ -409,11 +372,8 @@ export const sidebar: SideBar = {
409372
},
410373
],
411374
},
412-
// Blockchain API
413375
{
414-
name: "Blockchain API",
415-
icon: <CodeIcon />,
416-
href: "/connect/blockchain-api",
376+
name: "API References",
417377
links: [
418378
{
419379
name: "TypeScript",
@@ -449,42 +409,5 @@ export const sidebar: SideBar = {
449409
},
450410
],
451411
},
452-
{ separator: true },
453-
{
454-
name: "Platform API References",
455-
isCollapsible: false,
456-
links: [
457-
{
458-
name: "TypeScript",
459-
href: "/typescript/v5",
460-
icon: <TypeScriptIcon />,
461-
},
462-
{
463-
name: "React",
464-
href: "/react/v5",
465-
icon: <ReactIcon />,
466-
},
467-
{
468-
name: "React Native",
469-
href: "/react-native/v5",
470-
icon: <ReactIcon />,
471-
},
472-
{
473-
name: "Dotnet",
474-
href: "/dotnet",
475-
icon: <DotNetIcon />,
476-
},
477-
{
478-
name: "Unity",
479-
href: "/unity",
480-
icon: <UnityIcon />,
481-
},
482-
{
483-
name: "Unreal Engine",
484-
href: "/unreal-engine",
485-
icon: <UnrealEngineIcon />,
486-
},
487-
],
488-
},
489412
],
490413
};

0 commit comments

Comments
 (0)