You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: styleguides/STYLEGUIDE.md
+7-3Lines changed: 7 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,10 @@ These are the guidelines we use to write our docs.
4
4
5
5
## Content (grammar/structure)
6
6
7
+
### Alphabetize
8
+
9
+
Try to keep things in alphabetic order, except Next.js, React, and JavaScript are prioritized as these are our core SDKs. For example, our SDK selector prioritizes Next.js, React, and Javascript, and then alphabetizes the rest of the SDK's. Another example is that whenever there is a `<Tabs items={[]}>` component, the `items` should follow this same rule.
10
+
7
11
### De-dupe reference links
8
12
9
13
When mentioning a documented component, function, etc, multiple times on a page, link to the reference documentation on the **first mention** of that item. The exception to this rule is when the reference is mentioned under a different heading. In that case, link to the reference documentation again.
@@ -43,7 +47,7 @@ When writing titles that contain component references in MDX pages, wrap the com
43
47
> ✅
44
48
> Add it to your app's Middleware.
45
49
46
-
### Use "Sign in", not "Log in"
50
+
### Use "sign in" instead of "log in"
47
51
48
52
Use "sign in" and "sign out" rather than "log in" or "log out".
49
53
@@ -73,7 +77,7 @@ We refer to the reader with "you/your/yours." We objectively refer to Clerk as "
73
77
> ✅
74
78
> Clerk's `<ClerkProvider>` provides active session and user context to Clerk's hooks and other components. Import it into your app by adding `import { ClerkProvider } from '@clerk/nextjs'` at the top of your file.
75
79
76
-
## Use conjunctions
80
+
###Use conjunctions
77
81
78
82
Use conjunctions in the copy to make the copy more colloquial.
79
83
@@ -166,7 +170,7 @@ On this same page, under **Client credentials**, select **Add a certificate or s
166
170
On this same page, under **Client credentials**, select **Add a certificate or secret** to generate a Client Secret. You'll be redirected to the **Certificate & secrets** page.
0 commit comments