Skip to content

Commit 1705363

Browse files
mrzachnugentmrzachnugent
committed
feat(docs): add callout and manual instructions about project specific adjustments
1 parent 4a8fb0e commit 1705363

File tree

7 files changed

+107
-15
lines changed

7 files changed

+107
-15
lines changed

‎apps/docs/content/docs/blocks/authentication/forgot-password-form.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ description: A form that sends a password reset OTP to the user's email address.
66
import { BlockPreviewCard } from '@docs/components/preview-card';
77
import { ForgotPasswordForm } from "@docs/components/blocks";
88
import { ExternalLinks } from "@docs/components/external-links";
9-
import { Step, Steps } from 'fumadocs-ui/components/steps';
9+
import { Step, Steps } from 'fumadocs-ui/components/steps';
1010
import { CommandTabs } from "@docs/components/command-tabs";
1111
import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } from '@docs/components/auth-block-tabs';
12+
import { Callout } from '@docs/components/callout';
1213

1314
<ExternalLinks links={[{ title: 'Clerk docs', url: 'https://go.clerk.com/Q1MKAz0' }]} />
1415

@@ -51,6 +52,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
5152
);
5253
}
5354
```
55+
56+
<Callout type="info">
57+
This block includes `// TODO:` comments where app-specific logic is required.
58+
</Callout>
59+
5460
</Step>
5561
</Steps>
5662
</AuthBlockTabsCliContent>
@@ -87,6 +93,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
8793
);
8894
}
8995
```
96+
97+
<Callout type="info">
98+
This block includes `// TODO:` comments where app-specific logic is required.
99+
</Callout>
100+
90101
</Step>
91102
</Steps>
92103
</AuthBlockTabsCliContent>
@@ -123,7 +134,9 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
123134

124135
<Step>
125136

126-
**Update the import paths to match your project setup.**
137+
**Adjust for your project setup.**
138+
139+
Update the import paths to match your project structure, and address any `// TODO:` comments by adding the app-specific logic they describe.
127140

128141
</Step>
129142
</Steps>

‎apps/docs/content/docs/blocks/authentication/reset-password-form.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ description: A form for resetting a password with an OTP sent via email.
66
import { BlockPreviewCard } from '@docs/components/preview-card';
77
import { ResetPasswordForm } from "@docs/components/blocks";
88
import { ExternalLinks } from "@docs/components/external-links";
9-
import { Step, Steps } from 'fumadocs-ui/components/steps';
9+
import { Step, Steps } from 'fumadocs-ui/components/steps';
1010
import { CommandTabs } from "@docs/components/command-tabs";
1111
import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } from '@docs/components/auth-block-tabs';
12+
import { Callout } from '@docs/components/callout';
1213

1314
<ExternalLinks links={[{ title: 'Clerk docs', url: 'https://go.clerk.com/Q1MKAz0' }]} />
1415

@@ -51,6 +52,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
5152
);
5253
}
5354
```
55+
56+
<Callout type="info">
57+
This block includes `// TODO:` comments where app-specific logic is required.
58+
</Callout>
59+
5460
</Step>
5561
</Steps>
5662
</AuthBlockTabsCliContent>
@@ -87,6 +93,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
8793
);
8894
}
8995
```
96+
97+
<Callout type="info">
98+
This block includes `// TODO:` comments where app-specific logic is required.
99+
</Callout>
100+
90101
</Step>
91102
</Steps>
92103
</AuthBlockTabsCliContent>
@@ -123,7 +134,9 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
123134

124135
<Step>
125136

126-
**Update the import paths to match your project setup.**
137+
**Adjust for your project setup.**
138+
139+
Update the import paths to match your project structure, and address any `// TODO:` comments by adding the app-specific logic they describe.
127140

128141
</Step>
129142
</Steps>

‎apps/docs/content/docs/blocks/authentication/sign-in-form.mdx

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ description: A form for signing in using email and password or social providers.
66
import { BlockPreviewCard } from '@docs/components/preview-card';
77
import { SignInForm } from "@docs/components/blocks";
88
import { ExternalLinks } from "@docs/components/external-links";
9-
import { Step, Steps } from 'fumadocs-ui/components/steps';
9+
import { Step, Steps } from 'fumadocs-ui/components/steps';
1010
import { CommandTabs } from "@docs/components/command-tabs";
1111
import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } from '@docs/components/auth-block-tabs';
12+
import { Callout } from '@docs/components/callout';
1213

1314
<ExternalLinks links={[{ title: 'Clerk docs', url: 'https://go.clerk.com/Q1MKAz0' }]} />
1415

@@ -51,6 +52,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
5152
);
5253
}
5354
```
55+
56+
<Callout type="info">
57+
This block includes `// TODO:` comments where app-specific logic is required.
58+
</Callout>
59+
5460
</Step>
5561
</Steps>
5662
</AuthBlockTabsCliContent>
@@ -68,7 +74,7 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
6874
<Step>
6975
**All set!**
7076

71-
You can import `SignInForm` in your app.
77+
You can now import `SignInForm` in your app.
7278

7379
```tsx
7480
import { SignInForm } from '@/components/sign-in-form';
@@ -87,6 +93,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
8793
);
8894
}
8995
```
96+
97+
<Callout type="info">
98+
This block includes `// TODO:` comments where app-specific logic is required.
99+
</Callout>
100+
90101
</Step>
91102
</Steps>
92103
</AuthBlockTabsCliContent>
@@ -125,9 +136,12 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
125136

126137
<Step>
127138

128-
**Update the import paths to match your project setup.**
139+
**Adjust for your project setup.**
140+
141+
Update the import paths to match your project structure, and address any `// TODO:` comments by adding the app-specific logic they describe.
129142

130143
</Step>
144+
131145
</Steps>
132146

133147
</AuthBlockTabsManualContent>

‎apps/docs/content/docs/blocks/authentication/sign-up-form.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ description: A form for creating an account with email and password or social pr
66
import { BlockPreviewCard } from '@docs/components/preview-card';
77
import { SignUpForm } from "@docs/components/blocks";
88
import { ExternalLinks } from "@docs/components/external-links";
9-
import { Step, Steps } from 'fumadocs-ui/components/steps';
9+
import { Step, Steps } from 'fumadocs-ui/components/steps';
1010
import { CommandTabs } from "@docs/components/command-tabs";
1111
import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } from '@docs/components/auth-block-tabs';
12+
import { Callout } from '@docs/components/callout';
1213

1314
<ExternalLinks links={[{ title: 'Clerk docs', url: 'https://go.clerk.com/Q1MKAz0' }]} />
1415

@@ -51,6 +52,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
5152
);
5253
}
5354
```
55+
56+
<Callout type="info">
57+
This block includes `// TODO:` comments where app-specific logic is required.
58+
</Callout>
59+
5460
</Step>
5561
</Steps>
5662
</AuthBlockTabsCliContent>
@@ -87,6 +93,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
8793
);
8894
}
8995
```
96+
97+
<Callout type="info">
98+
This block includes `// TODO:` comments where app-specific logic is required.
99+
</Callout>
100+
90101
</Step>
91102
</Steps>
92103
</AuthBlockTabsCliContent>
@@ -125,7 +136,9 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
125136

126137
<Step>
127138

128-
**Update the import paths to match your project setup.**
139+
**Adjust for your project setup.**
140+
141+
Update the import paths to match your project structure, and address any `// TODO:` comments by adding the app-specific logic they describe.
129142

130143
</Step>
131144
</Steps>

‎apps/docs/content/docs/blocks/authentication/social-connections.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ description: A set of buttons for authenticating through social providers.
66
import { BlockPreviewCard } from '@docs/components/preview-card';
77
import { SocialConnections } from "@docs/components/blocks";
88
import { ExternalLinks } from "@docs/components/external-links";
9-
import { Step, Steps } from 'fumadocs-ui/components/steps';
9+
import { Step, Steps } from 'fumadocs-ui/components/steps';
1010
import { CommandTabs } from "@docs/components/command-tabs";
1111
import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } from '@docs/components/auth-block-tabs';
12+
import { Callout } from '@docs/components/callout';
1213

1314
<ExternalLinks links={[{ title: 'Clerk docs', url: 'https://go.clerk.com/Q1MKAz0' }]} />
1415

@@ -48,6 +49,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
4849
);
4950
}
5051
```
52+
53+
<Callout type="info">
54+
This block includes `// TODO:` comments where app-specific logic is required.
55+
</Callout>
56+
5157
</Step>
5258
</Steps>
5359
</AuthBlockTabsCliContent>
@@ -81,6 +87,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
8187
);
8288
}
8389
```
90+
91+
<Callout type="info">
92+
This block includes `// TODO:` comments where app-specific logic is required.
93+
</Callout>
94+
8495
</Step>
8596
</Steps>
8697
</AuthBlockTabsCliContent>
@@ -113,7 +124,9 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
113124

114125
<Step>
115126

116-
**Update the import paths to match your project setup.**
127+
**Adjust for your project setup.**
128+
129+
Update the import paths to match your project structure, and address any `// TODO:` comments by adding the app-specific logic they describe.
117130

118131
</Step>
119132
</Steps>

‎apps/docs/content/docs/blocks/authentication/user-menu.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ description: A popover menu presenting options and actions for the current user.
66
import { BlockPreviewCard } from '@docs/components/preview-card';
77
import { UserMenu } from "@docs/components/blocks";
88
import { ExternalLinks } from "@docs/components/external-links";
9-
import { Step, Steps } from 'fumadocs-ui/components/steps';
9+
import { Step, Steps } from 'fumadocs-ui/components/steps';
1010
import { CommandTabs } from "@docs/components/command-tabs";
1111
import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } from '@docs/components/auth-block-tabs';
12+
import { Callout } from '@docs/components/callout';
1213

1314
<ExternalLinks links={[{ title: 'Clerk docs', url: 'https://go.clerk.com/Q1MKAz0' }]} />
1415

@@ -46,6 +47,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
4647
);
4748
}
4849
```
50+
51+
<Callout type="info">
52+
This block includes `// TODO:` comments where app-specific logic is required.
53+
</Callout>
54+
4955
</Step>
5056
</Steps>
5157
</AuthBlockTabsCliContent>
@@ -77,6 +83,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
7783
);
7884
}
7985
```
86+
87+
<Callout type="info">
88+
This block includes `// TODO:` comments where app-specific logic is required.
89+
</Callout>
90+
8091
</Step>
8192
</Steps>
8293
</AuthBlockTabsCliContent>
@@ -112,7 +123,9 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
112123

113124
<Step>
114125

115-
**Update the import paths to match your project setup.**
126+
**Adjust for your project setup.**
127+
128+
Update the import paths to match your project structure, and address any `// TODO:` comments by adding the app-specific logic they describe.
116129

117130
</Step>
118131
</Steps>

‎apps/docs/content/docs/blocks/authentication/verify-email-form.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ description: A form for verifying an email address with an OTP sent via email.
66
import { BlockPreviewCard } from '@docs/components/preview-card';
77
import { VerifyEmailForm } from "@docs/components/blocks";
88
import { ExternalLinks } from "@docs/components/external-links";
9-
import { Step, Steps } from 'fumadocs-ui/components/steps';
9+
import { Step, Steps } from 'fumadocs-ui/components/steps';
1010
import { CommandTabs } from "@docs/components/command-tabs";
1111
import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } from '@docs/components/auth-block-tabs';
12+
import { Callout } from '@docs/components/callout';
1213

1314
<ExternalLinks links={[{ title: 'Clerk docs', url: 'https://go.clerk.com/Q1MKAz0' }]} />
1415

@@ -51,6 +52,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
5152
);
5253
}
5354
```
55+
56+
<Callout type="info">
57+
This block includes `// TODO:` comments where app-specific logic is required.
58+
</Callout>
59+
5460
</Step>
5561
</Steps>
5662
</AuthBlockTabsCliContent>
@@ -87,6 +93,11 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
8793
);
8894
}
8995
```
96+
97+
<Callout type="info">
98+
This block includes `// TODO:` comments where app-specific logic is required.
99+
</Callout>
100+
90101
</Step>
91102
</Steps>
92103
</AuthBlockTabsCliContent>
@@ -123,7 +134,9 @@ import { AuthBlockTabs, AuthBlockTabsCliContent, AuthBlockTabsManualContent } fr
123134

124135
<Step>
125136

126-
**Update the import paths to match your project setup.**
137+
**Adjust for your project setup.**
138+
139+
Update the import paths to match your project structure, and address any `// TODO:` comments by adding the app-specific logic they describe.
127140

128141
</Step>
129142
</Steps>

0 commit comments

Comments
 (0)