Alessio Gravili
9f9db3ff81
chore: bump prettier, re-enable prettier for docs ( #11695 )
...
## Introducing Prettier for docs
Prettier [was originally disabled for our docs as it didn't support MDX
2.0](1fa636417f ),
outputting invalid MDX syntax.
This has since been fixed - prettier now supports MDX 2.0.
## Reducing print width
This also reduces the print width for the docs folder from 100 to 70.
Our docs code field are very narrow - this should help make code more
readable.
**Before**

**After**

**Before**

**After**

2025-03-14 17:13:08 +00:00
Said Akhrarov
5e4e27460e
docs: fix links and formatting ( #10346 )
...
### What?
This PR fixes numerous links across the docs, both internal docs links
and external links. This PR also fixes some minor formatting issues in
some places, as well as optically aligns the markdown tables in tables
that had broken links.
### Why?
To properly link readers to the correct location in the docs, and for
better formatting and easier consumption.
### How?
Changes to many `.mdx` files in the `docs` folder.
Notes:
- There are duplicative section id's in `docs/authentication/email.mdx`,
I've fixed one such link, but have left it as is for now.
2025-01-03 21:41:33 -07:00
Alessio Gravili
bb0c8a8c62
docs: fix incorrect mdx ( #10201 )
2024-12-27 20:18:31 +00:00
Sasha
bc2d7c91e0
docs: fix links to /access-control/overview ( #9619 )
...
Fixes links to **Access Control** like here
https://payloadcms.com/docs/access-control/fields
2024-11-29 21:40:03 +02:00
Sasha
197e3bc010
docs: corrects old imports ( #8769 )
...
1
`import type { Field } from 'payload/types'`
to
`import type { Field } from 'payload'`
2
`import { buildConfig } from 'payload/config'`
to
`import { buildConfig } from 'payload'`
3
```
import { SelectInput, useField } from 'payload/components/forms';
import { useAuth } from 'payload/components/utilities';
```
to
`import { SelectInput, useAuth, useField } from '@payloadcms/ui'`
4
uses `import type` for `import type { CollectionConfig } from 'payload'`
2024-10-18 10:47:47 +03:00
Jacob Fletcher
0e673c6335
docs: improves access control docs ( #7154 )
2024-07-15 15:29:11 -04:00
Jacob Fletcher
6578b85057
docs: improves hooks docs ( #7133 )
2024-07-12 19:51:17 +00:00
James Mikrut
effba3e45b
Chore/overview docs ( #6906 )
...
## Description
More progress to docs.
2024-06-24 13:17:50 -04:00
Jacob Fletcher
a20cf70105
docs: removes express
2024-05-13 10:29:59 -04:00
Alessio Gravili
ae7d6f97d2
chore: formatting and linting ( #3261 )
...
* chore: lint packages/payload
* chore: lint packages/db-postgres
* chore: lint packages/db-mongodb
* chore: update eslintrc exclusion rules
* chore: update eslintrc exclusion rules
* chore: lint misc files
* chore: run prettier through packages
* chore: run eslint on payload again
* chore: prettier misc files
* chore: prettier docs
2023-09-01 17:39:44 +02:00
Harrison-Blair
13179a9498
chore: misc documentation updates ( #2589 )
...
* chore: ensures example configs are being exported when necessary
* chore: adds note regarding updating of hidden fields
---------
Co-authored-by: Jessica Boezwinkle <jessica@trbl.design >
2023-05-01 16:28:13 -04:00
Elliot DeNolf
1ed867ce0c
docs: update examples with ts types
2022-08-23 11:43:24 -04:00
James
c9795133b3
feat: adds originalDoc to field access control
2022-03-07 10:53:57 -05:00
Elliot DeNolf
b383eb65c6
feat: autolabel fields when label is omitted ( #42 )
...
* feat: autolabel fields when omitted
* feat: handle autolabel in graphql mutation build
* feat: autolabel blocks
* test: add required slug field to blocks
* feat: handle graphql names when label is false
* feat: adds relationship field to test searchable input
* feat: handle block cell type labeling pluralization
* docs: remove all explicit labeling, no longer needed
* fix: falsey column labels, allows false array labels
* fix: client tests
* fix: auto-labels globals
* docs: globals auto-labeling and hooks clarification
* fix; proper object type naming
Co-authored-by: James <james@trbl.design >
2021-04-16 22:37:08 -04:00
James
339f7503a4
feat: provides field access control with document data
2021-03-14 13:40:45 -04:00
Jessica Boezwinkle
1ed189cfb9
fix: reverts ESLint syntax changes to mdx files
2021-02-04 11:36:09 -05:00
Jessica Boezwinkle
da61feb73b
feat: adds meta descriptions to docs
2021-02-04 11:04:18 -05:00
Alexander Chi
6e9f2afd61
Update fields.mdx to add missing comma
2021-01-16 22:38:26 +00:00
Elliot DeNolf
0575ab8125
docs: add desc and keywords
2021-01-09 10:32:22 -05:00
James
2b37bfd93e
docs: lowercases dir names
2021-01-06 08:37:29 -05:00