Skip to content

Commit f1ebee4

Browse files
chore(docs): Fix typos (#826)
1 parent f176173 commit f1ebee4

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

docs/docs/configuration/auth/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This page covers a range of frequently asked questions about Sourcebot's built-i
1111
</Accordion>
1212

1313
<Accordion title="I don't want to restrict access to my Sourcebot deployment, what should I do?">
14-
Every user must register an account within your Sourcebot deployment. However, this dosn't mean their access
14+
Every user must register an account within your Sourcebot deployment. However, this doesn't mean their access
1515
is restricted.
1616

1717
Unless member approval is required, anyone can sign up for an account on your deployment and immediately be granted access.

docs/docs/configuration/auth/providers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Providers
55
Sourcebot supports a wide range of different authentication providers through it's integration with [Auth.js](https://authjs.dev/). This page
66
highlights how to configure the various supported providers.
77

8-
If theres an authentication provider you'd like us to support, please [reach out](https://www.sourcebot.dev/contact).
8+
If there's an authentication provider you'd like us to support, please [reach out](https://www.sourcebot.dev/contact).
99

1010
# Core Authentication Providers
1111

docs/docs/configuration/environment-variables.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The following environment variables allow you to configure your Sourcebot deploy
1414
| `AUTH_EMAIL_CODE_LOGIN_ENABLED` | `false` | <p>Enables/disables authentication with a login code that's sent to a users email. `SMTP_CONNECTION_URL` and `EMAIL_FROM_ADDRESS` must also be set. Checkout the [auth docs](/docs/configuration/auth/overview) for more info </p> |
1515
| `AUTH_SECRET` | Automatically generated at startup if no value is provided. Generated using `openssl rand -base64 33` | <p>Used to validate login session cookies</p> |
1616
| `AUTH_URL` | - | <p>URL of your Sourcebot deployment, e.g., `https://example.com` or `http://localhost:3000`.</p> |
17-
| `CONFIG_PATH` | `-` | <p>The container relative path to the declerative configuration file. See [this doc](/docs/configuration/declarative-config) for more info.</p> |
17+
| `CONFIG_PATH` | `-` | <p>The container relative path to the declarative configuration file. See [this doc](/docs/configuration/declarative-config) for more info.</p> |
1818
| `DATA_CACHE_DIR` | `$DATA_DIR/.sourcebot` | <p>The root data directory in which all data written to disk by Sourcebot will be located.</p> |
1919
| `DATA_DIR` | `/data` | <p>The directory within the container to store all persistent data. Typically, this directory will be volume mapped such that data is persisted across container restarts (e.g., `docker run -v $(pwd):/data`)</p> |
2020
| `DATABASE_DATA_DIR` | `$DATA_CACHE_DIR/db` | <p>The data directory for the default Postgres database.</p> |

docs/docs/configuration/idp.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ in the GitHub identity provider config.
5757
<Accordion title="instructions">
5858
<Steps>
5959
<Step title="Register an Oauth Client">
60-
To begin, you must register an Oauth client in GitHub to faciliate the identity provider connection. You can do this by creating a **GitHub App** or a **GitHub OAuth App**. Either
60+
To begin, you must register an Oauth client in GitHub to facilitate the identity provider connection. You can do this by creating a **GitHub App** or a **GitHub OAuth App**. Either
6161
one works, but the **GitHub App** is the [recommended mechanism](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps).
6262

6363

@@ -80,7 +80,7 @@ in the GitHub identity provider config.
8080
</Tab>
8181
</Tabs>
8282
</Step>
83-
<Step title="Define environemnt variables">
83+
<Step title="Define environment variables">
8484
To provide Sourcebot the client id and secret for your OAuth client you must set them as environment variables. These can be named whatever you like
8585
(ex. `GITHUB_IDENTITY_PROVIDER_CLIENT_ID` and `GITHUB_IDENTITY_PROVIDER_CLIENT_SECRET`)
8686
</Step>

docs/docs/configuration/language-model-providers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ For a detailed description of all the providers, please refer to the [schema](ht
111111
"model": "YOUR_MODEL_HERE",
112112
"displayName": "OPTIONAL_DISPLAY_NAME",
113113
"resourceName": "YOUR_RESOURCE_NAME", // defaults to the AZURE_RESOURCE_NAME env var if not set
114-
"apiVersion": "OPTIONAL_API_VERSION", // defailts to 'preview' if not set
114+
"apiVersion": "OPTIONAL_API_VERSION", // defaults to 'preview' if not set
115115
"token": {
116116
"env": "AZURE_API_KEY"
117117
},
@@ -166,7 +166,7 @@ For a detailed description of all the providers, please refer to the [schema](ht
166166
### Google Vertex
167167

168168
<Note>If you're using an Anthropic model on Google Vertex, you must define a [Google Vertex Anthropic](#google-vertex-anthropic) provider instead</Note>
169-
<Note>The `credentials` paramater here expects a **path** to a [credentials](https://console.cloud.google.com/apis/credentials) file. This file **must be in a volume mounted by Sourcebot** for it to be readable.</Note>
169+
<Note>The `credentials` parameter here expects a **path** to a [credentials](https://console.cloud.google.com/apis/credentials) file. This file **must be in a volume mounted by Sourcebot** for it to be readable.</Note>
170170

171171
[Vercel AI SDK Google Vertex AI Docs](https://ai-sdk.dev/providers/ai-sdk-providers/google-vertex)
172172

@@ -191,7 +191,7 @@ For a detailed description of all the providers, please refer to the [schema](ht
191191

192192
### Google Vertex Anthropic
193193

194-
<Note>The `credentials` paramater here expects a **path** to a [credentials](https://console.cloud.google.com/apis/credentials) file. This file **must be in a volume mounted by Sourcebot** for it to be readable.</Note>
194+
<Note>The `credentials` parameter here expects a **path** to a [credentials](https://console.cloud.google.com/apis/credentials) file. This file **must be in a volume mounted by Sourcebot** for it to be readable.</Note>
195195

196196

197197
[Vercel AI SDK Google Vertex Anthropic Docs](https://ai-sdk.dev/providers/ai-sdk-providers/google-vertex#google-vertex-anthropic-provider-usage)

docs/docs/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ title: "Overview"
3636
<Accordion title="Key benefits">
3737
- **Bring your own model:** [Configure](/docs/configuration/language-model-providers) to any language model you'd like
3838
- **Inline citations:** Every answer Sourcebot provides is grounded with inline citations directly into your codebase
39-
- **Mutli-repo:** Ask questions about any repository you have indexed on Sourcebot
39+
- **Multi-repo:** Ask questions about any repository you have indexed on Sourcebot
4040
</Accordion>
4141

4242
<video

0 commit comments

Comments
 (0)