Skip to content

Commit c96d50d

Browse files
bratvanovbratvanov
authored
docs: various grammar and typo fixes (#14170)
I reviewed the docs for spelling, grammar, and major punctuation issues. This PR only fixes English-language errors and doesn’t modify code examples.
1 parent f2cabe7 commit c96d50d

34 files changed

+52
-52
lines changed

‎docs/access-control/fields.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const FieldWithAccessControl: Field = {
2323
```
2424

2525
<Banner type="warning">
26-
**Note:** Field Access Controls does not support returning
26+
**Note:** Field Access Control does not support returning
2727
[Query](../queries/overview) constraints like [Collection Access
2828
Control](./collections) does.
2929
</Banner>

‎docs/admin/metadata.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Every page within the Admin Panel automatically receives dynamic, auto-generated
1010

1111
Metadata is fully configurable at the root level and cascades down to individual collections, documents, and custom views. This allows for the ability to control metadata on any page with high precision, while also providing sensible defaults.
1212

13-
All metadata is injected into Next.js' [`generateMetadata`](https://nextjs.org/docs/app/api-reference/functions/generate-metadata) function. This used to generate the `<head>` of pages within the Admin Panel. All metadata options that are available in Next.js are exposed by Payload.
13+
All metadata is injected into Next.js' [`generateMetadata`](https://nextjs.org/docs/app/api-reference/functions/generate-metadata) function. This is used to generate the `<head>` of pages within the Admin Panel. All metadata options that are available in Next.js are exposed by Payload.
1414

1515
Within the Admin Panel, metadata can be customized at the following levels:
1616

‎docs/admin/overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ app
5656

5757
As shown above, all Payload routes are nested within the `(payload)` route group. This creates a boundary between the Admin Panel and the rest of your application by scoping all layouts and styles. The `layout.tsx` file within this directory, for example, is where Payload manages the `html` tag of the document to set proper [`lang`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) and [`dir`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) attributes, etc.
5858

59-
The `admin` directory contains all the _pages_ related to the interface itself, whereas the `api` and `graphql` directories contains all the _routes_ related to the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview). All admin routes are [easily configurable](#customizing-routes) to meet your application's exact requirements.
59+
The `admin` directory contains all the _pages_ related to the interface itself, whereas the `api` and `graphql` directories contain all the _routes_ related to the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview). All admin routes are [easily configurable](#customizing-routes) to meet your application's exact requirements.
6060

6161
<Banner type="warning">
6262
**Note:** If you don't intend to use the Admin Panel, [REST

‎docs/admin/preview.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The `options` object contains the following properties:
5353
| ------------ | ----------------------------------------------------- |
5454
| **`locale`** | The current locale of the Document being edited. |
5555
| **`req`** | The Payload Request object. |
56-
| **`token`** | The JWT token of the currently authenticated in user. |
56+
| **`token`** | The JWT token of the currently authenticated user. |
5757

5858
If your application requires a fully qualified URL, such as within deploying to Vercel Preview Deployments, you can use the `req` property to build this URL:
5959

@@ -225,7 +225,7 @@ export default async function Page({ params: paramsPromise }) {
225225
```
226226

227227
<Banner type="success">
228-
**Note:** For fully working example of this, check of the official [Draft
228+
**Note:** For fully working example of this, check out the official [Draft
229229
Preview
230230
Example](https://github.com/payloadcms/payload/tree/main/examples/draft-preview)
231231
in the [Examples

‎docs/authentication/email.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Authentication Emails
33
label: Email Verification
44
order: 30
5-
desc: Email Verification allows users to verify their email address before they're account is fully activated. Email Verification ties directly into the Email functionality that Payload provides.
5+
desc: Email Verification allows users to verify their email address before their account is fully activated. Email Verification ties directly into the Email functionality that Payload provides.
66
keywords: authentication, email, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
77
---
88

‎docs/custom-components/document-views.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ desc:
66
keywords:
77
---
88

9-
Document Views consist of multiple, individual views that together represent any single [Collection](../configuration/collections) or [Global](../configuration/globals) Document. All Document Views and are scoped under the `/collections/:collectionSlug/:id` or the `/globals/:globalSlug` route, respectively.
9+
Document Views consist of multiple, individual views that together represent any single [Collection](../configuration/collections) or [Global](../configuration/globals) Document. All Document Views are scoped under the `/collections/:collectionSlug/:id` or the `/globals/:globalSlug` route, respectively.
1010

1111
There are a number of default Document Views, such as the [Edit View](./edit-view) and API View, but you can also create [entirely new views](./custom-views#adding-new-views) as needed. All Document Views share a layout and can be given their own tab-based navigation, if desired.
1212

‎docs/custom-components/edit-view.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ desc:
66
keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
77
---
88

9-
The Edit View is where users interact with individual [Collection](../configuration/collections) and [Global](../configuration/globals) Documents within the [Admin Panel](../admin/overview). The Edit View contains the actual form in which submits the data to the server. This is where they can view, edit, and save their content. It contains controls for saving, publishing, and previewing the document, all of which can be customized to a high degree.
9+
The Edit View is where users interact with individual [Collection](../configuration/collections) and [Global](../configuration/globals) Documents within the [Admin Panel](../admin/overview). The Edit View contains the actual form that submits the data to the server. This is where they can view, edit, and save their content. It contains controls for saving, publishing, and previewing the document, all of which can be customized to a high degree.
1010

1111
The Edit View can be swapped out in its entirety for a Custom View, or it can be injected with a number of Custom Components to add additional functionality or presentational elements without replacing the entire view.
1212

1313
<Banner type="warning">
1414
**Note:** The Edit View is one of many [Document Views](./document-views) in
1515
the Payload Admin Panel. Each Document View is responsible for a different
16-
aspect of the interacting with a single Document.
16+
aspect of interacting with a single Document.
1717
</Banner>
1818

1919
## Custom Edit View
@@ -74,7 +74,7 @@ In addition to swapping out the entire Edit View with a [Custom View](./custom-v
7474

7575
<Banner type="warning">
7676
**Important:** Collection and Globals are keyed to a different property in the
77-
`admin.components` object have slightly different options. Be sure to use the
77+
`admin.components` object and have slightly different options. Be sure to use the
7878
correct key for the entity you are working with.
7979
</Banner>
8080

@@ -199,7 +199,7 @@ export function MySaveButton(props: SaveButtonClientProps) {
199199

200200
The `beforeDocumentControls` property allows you to render custom components just before the default document action buttons (like Save, Publish, or Preview). This is useful for injecting custom buttons, status indicators, or any other UI elements before the built-in controls.
201201

202-
To add `beforeDocumentControls` components, use the `components.edit.beforeDocumentControls` property in you [Collection Config](../configuration/collections) or `components.elements.beforeDocumentControls` in your [Global Config](../configuration/globals):
202+
To add `beforeDocumentControls` components, use the `components.edit.beforeDocumentControls` property in your [Collection Config](../configuration/collections) or `components.elements.beforeDocumentControls` in your [Global Config](../configuration/globals):
203203

204204
#### Collections
205205

‎docs/custom-components/root-components.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The following options are available:
5252
_For details on how to build Custom Components, see [Building Custom Components](./overview#building-custom-components)._
5353

5454
<Banner type="success">
55-
**Note:** You can also use set [Collection
55+
**Note:** You can also set [Collection
5656
Components](../configuration/collections#custom-components) and [Global
5757
Components](../configuration/globals#custom-components) in their respective
5858
configs.

‎docs/database/mongodb.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ export default buildConfig({
7777
We export compatibility options for [DocumentDB](https://aws.amazon.com/documentdb/), [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db) and [Firestore](https://cloud.google.com/firestore/mongodb-compatibility/docs/overview). Known limitations:
7878

7979
- Azure Cosmos DB does not support transactions that update two or more documents in different collections, which is a common case when using Payload (via hooks).
80-
- Azure Cosmos DB the root config property `indexSortableFields` must be set to `true`.
80+
- Azure Cosmos DB requires the root config property `indexSortableFields` to be set to `true`.

‎docs/database/postgres.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export default buildConfig({
5151
```
5252

5353
<Banner type="info">
54-
**Note:** If you're using `vercelPostgresAdapter` your
54+
**Note:** If you're using `vercelPostgresAdapter` and your
5555
`process.env.POSTGRES_URL` or `pool.connectionString` points to a local
5656
database (e.g hostname has `localhost` or `127.0.0.1`) we use the `pg` module
5757
for pooling instead of `@vercel/postgres`. This is because `@vercel/postgres`

0 commit comments

Comments
 (0)