Skip to content

Commit 61b8663

Browse files
committed
add alphabetize rule to styleguide
1 parent 83a13bf commit 61b8663

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

styleguides/STYLEGUIDE.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ These are the guidelines we use to write our docs.
44

55
## Content (grammar/structure)
66

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+
711
### De-dupe reference links
812

913
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
4347
>
4448
> Add it to your app's Middleware.
4549
46-
### Use "Sign in", not "Log in"
50+
### Use "sign in" instead of "log in"
4751

4852
Use "sign in" and "sign out" rather than "log in" or "log out".
4953

@@ -73,7 +77,7 @@ We refer to the reader with "you/your/yours." We objectively refer to Clerk as "
7377
>
7478
> 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.
7579
76-
## Use conjunctions
80+
### Use conjunctions
7781

7882
Use conjunctions in the copy to make the copy more colloquial.
7983

@@ -166,7 +170,7 @@ On this same page, under **Client credentials**, select **Add a certificate or s
166170
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.
167171
```
168172

169-
## Ensure vs. make sure
173+
### Ensure vs. make sure
170174

171175
Use "ensure" instead of "make sure."
172176

0 commit comments

Comments
 (0)