Anyu Jiang
e2f7889d72
docs: fix typos, duplicated words, wrong property names etc. ( #12480 )
...
### What?
fix typos in doc
### Why?
because they are typos
### How?
checked manually with the help of AI
2025-05-25 10:58:26 -07:00
Jessica Chowdhury
6b349378e0
feat: adds and exports reusable auth server functions ( #11900 )
...
### What
Adds exportable server functions for `login`, `logout` and `refresh`
that are fully typed and ready to use.
### Why
Creating server functions for these auth operations require the
developer to manually set and handle the cookies / auth JWT. This can be
a complex and involved process - instead we want to provide an option
that will handle the cookies internally and simplify the process for the
user.
### How
Three re-usable functions can be exported from
`@payload/next/server-functions`:
- login
- logout
- refresh
Examples of how to use these functions will be added to the docs
shortly, along with more in-depth info on server functions.
2025-04-14 09:47:08 +01:00
Jacob Fletcher
5f7202bbb8
docs: payload proper nouns ( #11792 )
...
Uses proper nouns in the docs where necessary for "Payload" and "Local
API".
2025-03-21 09:04:11 -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
Said Akhrarov
8952662db9
docs: fix links and formatting ( #10835 )
...
### What?
This PR fixes many links in the docs as well as a few formatting and
grammar issues.
### Why?
To properly link users to the correct destination in the docs and
present well-formatted docs.
### How?
Changes to a few files in `docs/`
2025-01-27 22:50:54 -07:00
James Mikrut
6af6e44683
docs: adds notes about importance of serverURL for verify / forgot-pa… ( #10248 )
...
Fixes #10235
2024-12-30 10:20:28 -05:00
James Mikrut
363a24cea5
docs: add clarity about forgot-password and verify tokens ( #10247 )
...
Adds clarity to `verifyEmail` docs, noting that the token for
`forgotPassword` is different.
Fixes #10236
2024-12-30 10:04:54 -05:00
Alessio Gravili
bb0c8a8c62
docs: fix incorrect mdx ( #10201 )
2024-12-27 20:18:31 +00:00
Said Akhrarov
9c59359da6
docs: fix invalid links ( #9500 )
...
### What?
This PR fixes a variety of links around the docs.
### Why?
To link readers to the correct location in the docs
### How?
Changes and fixes to a number of doc links.
2024-11-24 19:18:33 -07:00
Jacob Fletcher
edb501349f
docs: improves authentication docs ( #7195 )
2024-07-17 12:52:41 -04:00
Jacob Fletcher
0e673c6335
docs: improves access control docs ( #7154 )
2024-07-15 15:29:11 -04:00
Jacob Fletcher
5a76d6db8b
docs: improves configuration docs ( #7090 )
2024-07-09 18:10:04 -04:00
James Mikrut
2daefb2a81
chore: removes unused token arg to refresh operation ( #6977 )
...
## Description
Duplicate of #6976 for 3.x
2024-06-28 11:20:49 -04:00
Jarrod Flesch
39868426b6
chore: updated 3.0 auth docs ( #6861 )
2024-06-21 15:34:25 -04:00
Jacob Fletcher
a20cf70105
docs: removes express
2024-05-13 10:29:59 -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
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
Jacob Fletcher
caee0c07d7
docs: gql me query ( #1949 )
2023-01-27 10:15:53 -05:00
Jarrod Flesch
eda6f70acb
Roadmap/#1379 admin ui doc level access ( #1624 )
...
* feat: adds document level access endpoints so admin ui can now accurately reflect document level access control
* chore(docs): new doc access callout, updates useDocumentInfo props from change
2022-12-14 16:14:29 -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
James
7fc8f6dd3c
docs: corrects refresh-token rest route
2021-09-15 13:46:55 -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
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