Skip to content

Commit 7a6be15

Browse files
changeworldchangeworld
authored
chore: fix GitHub typo (#10781)
Fix typo - Github -> GitHub
1 parent fd4cc7d commit 7a6be15

File tree

39 files changed

+56
-56
lines changed

39 files changed

+56
-56
lines changed

‎.github/broken-link-checker/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ const postComment = async (outputMd: string) => {
8989
const prNumber = pullRequest.number
9090
if (isFork) {
9191
setFailed(
92-
"The action could not create a Github comment because it is initiated from a forked repo. View the action logs for a list of broken links."
92+
"The action could not create a GitHub comment because it is initiated from a forked repo. View the action logs for a list of broken links."
9393
)
9494
return ""
9595
}

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
<img src="https://img.shields.io/npm/dm/next-auth?style=flat-square" alt="Downloads" />
1313
</a>
1414
<a href="https://github.com/nextauthjs/next-auth/stargazers">
15-
<img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="Github Stars" />
15+
<img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="GitHub Stars" />
1616
</a>
1717
<a href="https://www.npmjs.com/package/next-auth">
18-
<img src="https://img.shields.io/github/v/release/nextauthjs/next-auth?label=latest&style=flat-square" alt="Github Stable Release" />
18+
<img src="https://img.shields.io/github/v/release/nextauthjs/next-auth?label=latest&style=flat-square" alt="GitHub Stable Release" />
1919
</a>
2020
<a href="https://codecov.io/gh/nextauthjs/next-auth" >
2121
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/nextauthjs/next-auth?token=o2KN5GrPsY&style=flat-square&logo=codecov">

‎apps/dev/nextjs/app/client.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export default function Client() {
3333
</>
3434
) : (
3535
<>
36-
<button onClick={() => signIn("github")}>Sign in Github</button>
36+
<button onClick={() => signIn("github")}>Sign in GitHub</button>
3737
<button onClick={() => signIn("credentials", {})}>
3838
Sign in Credentials
3939
</button>

‎apps/dev/sveltekit/src/routes/+page.svelte

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
<span slot="submitButton">
6767
<img
6868
src="https://authjs.dev/img/providers/github.svg"
69-
alt="Github Logo"
69+
alt="GitHub Logo"
7070
width="32"
7171
height="32"
7272
/>
@@ -124,7 +124,7 @@
124124
<button on:click={() => signIn("github")}>
125125
<img
126126
src="https://authjs.dev/img/providers/github.svg"
127-
alt="Github Logo"
127+
alt="GitHub Logo"
128128
width="32"
129129
height="32"
130130
/>

‎docs/components/Guides/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export function Guides() {
4646
<div className="flex gap-2">
4747
<GithubLogo className="size-8" />
4848
<div className="flex flex-col items-start">
49-
OAuth with Github
49+
OAuth with GitHub
5050
<span className="text-neutral-400 dark:text-neutral-700">
5151
Step-by-step guide to set up an OAuth provider.
5252
</span>

‎docs/components/OAuthProviderInstructions/OAuthProviderSelect.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@ export function OAuthProviderSelect() {
7171
role="button"
7272
className="flex flex-col justify-between items-center p-4 w-32 h-32 rounded-lg border border-solid shadow-sm transition-colors duration-300 border-neutral-200 dark:border-neutral-800 dark:hover:bg-neutral-950 hover:bg-neutral-50"
7373
onClick={() =>
74-
handleSelectOption({ id: "github", name: "Github" })
74+
handleSelectOption({ id: "github", name: "GitHub" })
7575
}
7676
>
7777
<img src={`/img/providers/github.svg`} className="mt-2 w-11" />
78-
<div className="text-sm text-center">Github</div>
78+
<div className="text-sm text-center">GitHub</div>
7979
</div>
8080
<div
8181
role="button"

‎docs/components/OAuthProviderInstructions/content/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export function OAuthInstructions({ providerId, disabled = false }: Props) {
5757
If you haven’t used OAuth before, you can read the beginners
5858
step-by-step guide on{" "}
5959
<Link href="/guides/configuring-github">
60-
how to setup "Sign in with Github" with Auth.js
60+
how to setup "Sign in with GitHub" with Auth.js
6161
</Link>
6262
.
6363
</Callout>

‎docs/pages/concepts/oauth.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,26 +32,26 @@ Below are two diagrams visually illustrating the same basic flow as described ab
3232
sequenceDiagram
3333
participant Browser
3434
participant App Server
35-
participant Auth Server (Github)
35+
participant Auth Server (GitHub)
3636
Note left of Browser: User clicks on "Sign in"
3737
Browser->>App Server: GET<br/>"api/auth/signin"
3838
App Server->>App Server: Computes the available<br/>sign in providers<br/>from the "providers" option
3939
App Server->>Browser: Redirects to Sign in page
40-
Note left of Browser: Sign in options<br/>are shown the user<br/>(Github, Twitter, etc...)
41-
Note left of Browser: User clicks on<br/>"Sign in with Github"
40+
Note left of Browser: Sign in options<br/>are shown the user<br/>(GitHub, Twitter, etc...)
41+
Note left of Browser: User clicks on<br/>"Sign in with GitHub"
4242
Browser->>App Server: POST<br/>"api/auth/signin/github"
43-
App Server->>App Server: Computes sign in<br/>options for Github<br/>(scopes, callback URL, etc...)
44-
App Server->>Auth Server (Github): GET<br/>"github.com/login/oauth/authorize"
45-
Note left of Auth Server (Github): Sign in options<br> are supplied as<br/>query params<br/>(clientId, <br/>scope, etc...)
46-
Auth Server (Github)->>Browser: Shows sign in page<br/>in Github.com<br/>to the user
47-
Note left of Browser: User inserts their<br/>credentials in Github
48-
Browser->>Auth Server (Github): Github validates the inserted credentials
49-
Auth Server (Github)->>Auth Server (Github): Generates one time access code<br/>and calls callback<br>URL defined in<br/>App settings
50-
Auth Server (Github)->>App Server: GET<br/>"api/auth/github/callback?code=123"
43+
App Server->>App Server: Computes sign in<br/>options for GitHub<br/>(scopes, callback URL, etc...)
44+
App Server->>Auth Server (GitHub): GET<br/>"github.com/login/oauth/authorize"
45+
Note left of Auth Server (GitHub): Sign in options<br> are supplied as<br/>query params<br/>(clientId, <br/>scope, etc...)
46+
Auth Server (GitHub)->>Browser: Shows sign in page<br/>in GitHub.com<br/>to the user
47+
Note left of Browser: User inserts their<br/>credentials in GitHub
48+
Browser->>Auth Server (GitHub): GitHub validates the inserted credentials
49+
Auth Server (GitHub)->>Auth Server (GitHub): Generates one time access code<br/>and calls callback<br>URL defined in<br/>App settings
50+
Auth Server (GitHub)->>App Server: GET<br/>"api/auth/github/callback?code=123"
5151
App Server->>App Server: Grabs code<br/>to exchange it for<br/>access token
52-
App Server->>Auth Server (Github): POST<br/>"github.com/login/oauth/access_token"<br/>{code: 123}
53-
Auth Server (Github)->>Auth Server (Github): Verifies code is<br/>valid and generates<br/>access token
54-
Auth Server (Github)->>App Server: { access_token: 16C7x... }
52+
App Server->>Auth Server (GitHub): POST<br/>"github.com/login/oauth/access_token"<br/>{code: 123}
53+
Auth Server (GitHub)->>Auth Server (GitHub): Verifies code is<br/>valid and generates<br/>access token
54+
Auth Server (GitHub)->>App Server: { access_token: 16C7x... }
5555
App Server->>App Server: Generates session token<br/>and stores session
5656
App Server->>Browser: You're now logged in!
5757
```

‎docs/pages/getting-started/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ history](/contributors#history).
148148

149149
There are 4 ways to authenticate users with Auth.js:
150150

151-
- [OAuth authentication](/getting-started/authentication/oauth) (_Sign in with Google, Github, LinkedIn, etc..._)
151+
- [OAuth authentication](/getting-started/authentication/oauth) (_Sign in with Google, GitHub, LinkedIn, etc..._)
152152
- [Magic Links](/getting-started/authentication/email) (_Email Provider like Resend, Sendgrid, Nodemailer etc..._)
153153
- [Credentials](/getting-started/authentication/credentials) (_Username and Password, Integrating with external APIs, etc..._)
154154
- [WebAuthn](/getting-started/authentication/webauthn) (_Passkeys, etc..._)

‎docs/pages/global.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ pre code.nextra-code:not(:has(span)) {
127127
cursor: pointer;
128128
}
129129

130-
/* Navbar Github Star Counter */
130+
/* Navbar GitHub Star Counter */
131131
.github-counter {
132132
position: absolute;
133133
color: #000;

0 commit comments

Comments
 (0)