Alessio Gravili
f7ed8e90e1
docs: fix invalid markdown ( #11996 )
2025-04-04 12:41:54 -04:00
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
Alessio Gravili
152a9b6adf
docs: fix invalid link ( #11174 )
...
Links have to be defined in markdown - html a tags won't automatically be converted to links anymore.
2025-02-13 16:46:20 -07:00
Alexander Cato
8ace0cab33
docs: correct grammar and improve clarity on preventing-abuse.mdx ( #10937 )
...
## What
Refactored the explanation of complexity limits in the
preventing-abuse.mdx documentation to correct grammar and improve
clarity.
## Why
- Grammar fix: The original sentence omitted the preposition "to" ("way
specify" → "way to specify").
- Readability: The long, compound sentence was difficult to parse at a
glance.
- Concept separation: Merging two ideas (defining limits and explaining
scoring) confused the workflow.
## How
- Added the missing "to" to ensure grammatical correctness.
- Split the sentence into two parts:
1. Introduces the purpose of complexity limits.
2. Explains how complexity scores enforce these limits.
- Preserved technical accuracy while simplifying the flow.
2025-02-02 19:07:52 -07:00
Alessio Gravili
bb0c8a8c62
docs: fix incorrect mdx ( #10201 )
2024-12-27 20:18:31 +00:00
Marcus Forsberg
0588394a47
docs: fix broken links to csrf and e-mail verification docs ( #10140 )
...
### What?
This fixes a couple of broken links, specifically to the CSRF and the
e-mail verification doc pages, which appear to have been moved from the
root Authentication page.
### Why?
While it makes sense to familiarize one self with the Authentication
Overview page as well, if you are specifically looking for info on CSRF
protection (which I was doing while evaluting Payload for my agency),
the link should go to the right place.
2024-12-23 03:09:50 -05:00
Elliot DeNolf
340bc85560
docs: add output standalone in docker deployment section ( #9738 )
...
Adds details about `output: 'standalone'` to Docker deployment section.
This is required in order for Next.js to be dockerized.
```
const nextConfig = {
output: 'standalone',
}
```
2024-12-04 14:57:02 +00:00
Dan Ribbens
a25ddc5448
docs: migration guide more info ( #9305 )
2024-11-18 17:35:36 -05:00
Jacob Fletcher
edb501349f
docs: improves authentication docs ( #7195 )
2024-07-17 12:52:41 -04:00
Jacob Fletcher
a1bb661a1a
docs: misc improvements ( #7107 )
2024-07-11 09:54:21 -04:00
James Mikrut
314488e55a
Chore/overview docs ( #6908 )
...
## Description
docs tweaks
2024-06-24 13:57:01 -04: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
Jacob Fletcher
1a20390454
docs: removes bundlers, webpack, and vite
2024-05-09 15:58:51 -04:00
Alessio Gravili
19f8cbcf76
docs: new and improve lexical docs, hoist up all headings ( #6639 )
2024-06-05 17:08:15 -04:00
Alessio Gravili
6789e61488
chore: run lint & prettier on everything
2024-03-14 23:53:47 -04:00
Dan Ribbens
0cc91d7377
docs: update mongoOptions to connectOptions ( #4334 )
2023-11-30 12:39:32 -05:00
Jessica Chowdhury
6325b334ec
chore(docs): adds section on swap space and nextjs incompatibilities with the local api ( #3975 )
2023-11-02 08:40:24 -04:00
Tylan Davis
8bfae6b932
docs: removes MONGODB_URI ( #3482 )
2023-10-09 18:07:09 -04:00
Alessio Gravili
a81401cf77
feat: breaking: richtext adapter ( #3311 )
...
BREAKING: requires user to install @payloacms-richtext-slate and specify a `config.editor` property
* chore: move slate stuff into packages/richtext-slate
* chore: fieldTypes stuff
* chore: fix richtext-slate tsconfig
* chore: add clean:unix command
* chore: fix up things
* chore: undo subpath imports being hoisted up
* chore: fix incorrect imports
* chore: improve AdapterArguments type
* chore: remove unused richTextToHTML and stringifyRichText files
* fix: core-dev scss imports
* chore: fix publishConfig exports for richtext-slate
* chore: adjust joi schema for richtext field
* chore: various fixes
* chore: handle afterRead population in richText adapter
* chore: handle more after-read promise stuff
* chore: fix joi validation
* chore: add richtext adapter to tests
* chore: merge adapter props with field props
* chore: index.tsx => index.ts
* chore: rename `adapter` to `editor`
* chore: fix e2e tests not running due to importing a constant from a file (`Tabs`) which imports createSlate.
This fails because createSlate imports React components.
* chore: remove unnecessary import
* chore: improve various typings
* chore: improve typings for List view Cell components
* feat: richText adapter cell component
* chore: add missing types packages for packages/richtext-slate
* chore: add new adapter interface properties to joi schema
* chore: withMergedProps utility which replaces getSlateCellComponent and getSlateFieldComponent
* feat: added config.defaultEditor property which is now required. field.editor is no longer required and overrides config.defaultEditor
* docs: mention editor and defaultEditor property in the docs
* chore: fix incorrectly formatted JSX in docs files breaking mdx parser
* chore: fix various errors
* chore: auto-generated pointer files
2023-09-19 11:03:31 +02: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
Jarrod Flesch
d112159d93
docs: fix mdx formatting
2023-07-05 15:26:10 -04:00
Jacob Fletcher
9b22c4b654
docs: fixes misc links ( #2971 )
2023-07-05 12:02:56 -04:00
davidko604
feebf203b8
Update docs
2023-03-01 12:08:18 -08:00
Dan Ribbens
b4a20741b2
fix: useFacet config option to disable $facet aggregation ( #2141 )
2023-02-20 13:54:12 -05:00
Elliot DeNolf
3ebe7b4a7e
docs: add docker link to deployment toc
2023-02-11 14:05:57 -05:00
Elliot DeNolf
a1fd1e07f0
docs: add an initial Basics section to talk about the dist and build directories
2023-02-11 14:03:36 -05:00
Elliot DeNolf
f873fa8d99
docs: add example Dockerfile and docker-compose.yml ( #1735 )
...
* docs: add example Dockerfile and docker-compose.yml
* docs: link to docker deployment from installation
2022-12-21 11:39:32 -05:00
Jacob Fletcher
c9bfdbb63c
docs: rateLimit defaults
2022-11-29 12:48:53 -05:00
Elliot DeNolf
1ed867ce0c
docs: update examples with ts types
2022-08-23 11:43:24 -04:00
Dan Ribbens
4913441017
Free and open-source under MIT license ( #565 )
...
* feat: free and open-source under MIT license
2022-05-16 19:25:20 -04:00
Dan Ribbens
69d328d15e
docs: updated link
2022-04-29 23:29:46 -04:00
Dan Ribbens
738e8ab9b6
docs: preventing abuse of file uploads
2022-04-29 23:25:55 -04:00
James
ad2b47e725
docs: clarity
2021-10-04 11:25:12 -04:00
Dan Ribbens
ad097820bf
feat: add indexSortableField option to create indexes for sortable fields on all collections
2021-09-30 16:05:47 -04:00
James
71a15b5e6d
docs: clarity around afterRead S3 hook
2021-03-13 13:55:01 -05:00
Dan Ribbens
a897631251
Merge pull request #87 from payloadcms/docs/fix-broken-links
...
docs: fixed broken links throughout docs
2021-03-04 08:12:58 -05:00
Dan Ribbens
fbf82fc205
docs: fixed broken links throughout docs
2021-03-04 08:01:20 -05:00
James
568c6bb7b2
docs: revises licensing
2021-03-01 08:39:23 -05: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
Elliot DeNolf
0575ab8125
docs: add desc and keywords
2021-01-09 10:32:22 -05:00
James
1304c8a95d
docs: licensing grammar issues
2021-01-09 08:09:38 -05:00
James
37f3633e0c
Merge branch 'feature/disable-gql' of github.com:payloadcms/payload
2021-01-07 19:55:10 -05:00
James
f3cf99aa5c
docs: licensing improvements
2021-01-07 17:23:28 -05:00
James
c4eec6dc12
docs: fixes licensing code example
2021-01-07 17:21:28 -05:00
Dan Ribbens
d78c76e0b4
feat: disable graphQL flag that will bypass gql on payload init
2021-01-06 15:43:42 -05:00
James
e3385e1243
docs: licensing additions
2021-01-06 09:13:44 -05:00
James
2b37bfd93e
docs: lowercases dir names
2021-01-06 08:37:29 -05:00