Skip to content

Commit 7bbc173

Browse files
[Documentation] Refactor: Reorganize Connect sidebar and simplify guides (#5625)
1 parent 5574c15 commit 7bbc173

File tree

7 files changed

+101
-268
lines changed

7 files changed

+101
-268
lines changed

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

Lines changed: 99 additions & 177 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,9 @@
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
16-
const connectSlug = "/connect/sign-in";
177
const inAppSlug = "/connect/in-app-wallet";
188

199
const walletSlug = "/connect/wallet";
@@ -49,150 +39,99 @@ export const sidebar: SideBar = {
4939
icon: <ExternalLink />,
5040
},
5141
{ separator: true },
42+
// Connect\
5243
{
53-
name: "Learn",
44+
name: "Onboard Users",
45+
expanded: true,
5446
isCollapsible: false,
5547
links: [
56-
// Connect\
5748
{
58-
name: "Wallets",
59-
icon: <WalletsInAppIcon />,
49+
name: "Overview",
50+
href: `${walletSlug}/overview`,
51+
},
52+
{
53+
name: "Security",
54+
href: `${walletSlug}/security`,
55+
},
56+
{
57+
name: "Get Started",
58+
href: `${walletSlug}/get-started`,
59+
},
60+
{
61+
name: "External Wallets",
62+
href: `${walletSlug}/sign-in-methods/external-wallets`,
63+
},
64+
{
65+
name: "In-App Wallets",
6066
links: [
6167
{
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`,
68+
name: "Sign-In Methods",
69+
href: `${walletSlug}/sign-in-methods/configure`,
7270
},
73-
7471
{
7572
name: "Pregenerate Wallets",
7673
href: `${walletSlug}/pregenerate-wallets`,
7774
},
7875
{
79-
name: "Sign-In Methods",
76+
name: "Guest Mode",
77+
href: `${walletSlug}/sign-in-methods/guest`,
78+
},
79+
{
80+
name: "Custom Authentication",
8081
links: [
8182
{
82-
name: "Configure",
83-
href: `${walletSlug}/sign-in-methods/configure`,
83+
name: "Overview",
84+
href: `${inAppSlug}/custom-auth/overview`,
8485
},
8586
{
86-
name: "Guest Mode",
87-
href: `${walletSlug}/sign-in-methods/guest`,
87+
name: "Configuration",
88+
href: `${inAppSlug}/custom-auth/configuration`,
8889
},
8990
{
90-
name: "External Wallets",
91-
href: `${walletSlug}/sign-in-methods/external-wallets`,
92-
},
93-
{
94-
name: "Custom Authentication",
91+
name: "Integration guides",
9592
links: [
9693
{
97-
name: "Overview",
98-
href: `${inAppSlug}/custom-auth/overview`,
94+
name: "Custom auth server (OIDC Auth)",
95+
href: `${inAppSlug}/custom-auth/custom-jwt-auth-server`,
9996
},
10097
{
101-
name: "Configuration",
102-
href: `${inAppSlug}/custom-auth/configuration`,
98+
name: "Custom auth server (Generic Auth)",
99+
href: `${inAppSlug}/custom-auth/custom-auth-server`,
103100
},
104101
{
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-
],
102+
name: "Firebase Auth",
103+
href: `${inAppSlug}/custom-auth/firebase-auth`,
120104
},
121105
],
122106
},
123107
],
124108
},
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-
},
109+
],
110+
},
111+
{
112+
name: "Ecosystem Wallets",
113+
links: [
148114
{
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-
],
115+
name: "Set-up",
116+
href: `${walletSlug}/ecosystem/set-up`,
160117
},
161118
{
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-
],
119+
name: "Ecosystem Portal",
120+
href: `${walletSlug}/ecosystem/portal`,
181121
},
182122
{
183-
name: "Migrate to thirdweb",
184-
href: `${walletSlug}/migrate-to-thirdweb`,
123+
name: "Managing Ecosystem Permissions",
124+
href: `${walletSlug}/ecosystem/permissions`,
185125
},
186126
{
187-
name: "FAQ",
188-
href: `${walletSlug}/faq`,
127+
name: "Integrating with Partners",
128+
href: `${walletSlug}/ecosystem/integrating-partners`,
189129
},
190130
],
191131
},
192132
//Account abstraction
193133
{
194134
name: "Account Abstraction",
195-
icon: <WalletsSmartIcon />,
196135
links: [
197136
{
198137
name: "Overview",
@@ -245,24 +184,6 @@ export const sidebar: SideBar = {
245184
name: "Sponsorship rules",
246185
href: `${aAslug}/sponsorship-rules`,
247186
},
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-
},
266187
// {
267188
// name: "References",
268189
// isCollapsible: true,
@@ -292,10 +213,26 @@ export const sidebar: SideBar = {
292213
},
293214
],
294215
},
216+
{
217+
name: "Migrate to thirdweb",
218+
href: `${walletSlug}/migrate-to-thirdweb`,
219+
},
220+
{
221+
name: "FAQ",
222+
href: `${walletSlug}/faq`,
223+
},
224+
],
225+
},
226+
{ separator: true },
227+
// User identity
228+
{
229+
name: "User Identity",
230+
isCollapsible: false,
231+
links: [
295232
// Auth
233+
// TODO move to TS reference
296234
{
297-
name: "Auth (SIWE)",
298-
icon: <WalletsAuthIcon />,
235+
name: "Sign In with Ethereum",
299236
links: [
300237
{
301238
name: "Get Started",
@@ -322,10 +259,35 @@ export const sidebar: SideBar = {
322259
},
323260
],
324261
},
262+
{
263+
name: "Get User Profiles",
264+
href: `${walletSlug}/user-management/get-user-profiles`,
265+
},
266+
{
267+
name: "Link Multiple Identities",
268+
href: `${walletSlug}/user-management/link-multiple-identity`,
269+
},
270+
{
271+
name: "Export Private Keys",
272+
href: `${walletSlug}/user-management/export-private-key`,
273+
},
274+
// TODO:
275+
// {
276+
// name: "Deleting User Details",
277+
// href: `${walletSlug}/user-management/deleting-user-details`,
278+
// },
279+
],
280+
},
281+
{ separator: true },
282+
// Blockchain API
283+
// TODO Overview page?
284+
{
285+
name: "Onchain Interactions",
286+
isCollapsible: false,
287+
links: [
325288
// Pay
326289
{
327-
name: "Pay",
328-
icon: <PayIcon />,
290+
name: "Bridge & Swap",
329291
links: [
330292
{
331293
name: "Overview",
@@ -409,11 +371,8 @@ export const sidebar: SideBar = {
409371
},
410372
],
411373
},
412-
// Blockchain API
413374
{
414-
name: "Blockchain API",
415-
icon: <CodeIcon />,
416-
href: "/connect/blockchain-api",
375+
name: "API References",
417376
links: [
418377
{
419378
name: "TypeScript",
@@ -449,42 +408,5 @@ export const sidebar: SideBar = {
449408
},
450409
],
451410
},
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-
},
489411
],
490412
};

0 commit comments

Comments
 (0)