Merge branch 'master' into feat/ai-guides

Author: bcbogdan

.vale.ini

@@ -4,7 +4,8 @@ MinAlertLevel = suggestion
 
 Vocab = Authentication
 
-IgnoredScopes = text.frontmatter.page_type, text.frontmatter.category
+IgnoredScopes = text.frontmatter.page_type, text.frontmatter.category, text.frontmatter.recipe, text.frontmatter.id, code
+IgnoredClasses = inline-code
 
 [*.{md,mdx}]
 BasedOnStyles = SuperTokens 

.vale/SuperTokens/acronyms.yml

@@ -32,6 +32,7 @@ exceptions:
   - SAML
   - GUI
   - CDI
+  - FDI
   - XYZ
   - HTML
   - HTTP
@@ -47,3 +48,10 @@ exceptions:
   - YAML
   - TOTP
   - ZIP
+  - POST
+  - PUT
+  - DELETE
+  - GET
+  - REST
+  - AWS
+  - JWKS

.vale/SuperTokens/headings.yml

@@ -51,6 +51,16 @@ exceptions:
   - Unified Login
   - JWT
   - JWTs
+  - SDK
   - UI
   - Token
   - WebAuthn
+  - JWKS
+  - NestJS
+  - ID
+  - GDPR
+  - HTTPS
+  - SMS
+  - SSL
+  - SMTP
+  - ThirdParty

.vale/SuperTokens/spelling.yml

@@ -24,6 +24,8 @@ filters:
   - "refetch"
   - "authorizer"
   - "Authorizer"
+  - "upsert"
+  - "Upsert"
   - "cron"
   - "Cron"
   # Abbreviations and Brand Names
@@ -34,6 +36,7 @@ filters:
   - "API's"
   - "JWT[s]"
   - "URI[s]"
+  - "URL[s]"
   - "MAU[s]"
   - "XMLHTTPRequest"
   - "XML"
@@ -87,3 +90,10 @@ filters:
   - "[Uu]nlink[ing]"
   - "deduplication"
   - "Callout"
+  - "uri"
+  - "websocket"
+  - "cli"
+  - "CLI"
+  - "Unverify"
+  - "FDI"
+  - "CDI"

.vale/SuperTokens/words.yml

@@ -18,6 +18,8 @@ swap:
   (?:kubernetes|k8s|K8s|K8S): Kubernetes
   https: HTTPS
   http: HTTP
+  uri: URI
+  url: URL
   tenantId: "`tenantId`"
   userId: "`userId`"
   pre built: pre-built

docs/_templates/api-reference.md

@@ -1,4 +1,4 @@
-# API Reference template
+# API reference template
 
 > The following template is taken from [The Good Docs Project](https://www.thegooddocsproject.dev/template/api-reference)
 > Some adjustments/clarifications have been made in the context of the **SuperTokens** docs.
@@ -32,7 +32,7 @@ Authentication and authorization {is | is not} required for requests to these AP
 
 {This section is optional.}
 
-Due to the potentially very large result sets from API calls, responses {are | can be} returned as shorter pages.
+Due to the large result sets from API calls, responses {are | can be} returned as shorter pages.
 
 Pagination can be customized using {pagination settings}. If not specified, the default values are {values}.
 
@@ -64,7 +64,7 @@ The {product} APIs use the following error types:
 |                                         |                  |
 |                                         |                  |
 
-#### ExampleErrorType
+#### Example error type
 
 | Field            | Type       | Description                                                            |
 | ---------------- | ---------- | ---------------------------------------------------------------------- |

docs/_templates/tutorial.md

@@ -22,7 +22,7 @@ By the end of this tutorial, you'll be able to:
 ## Background
 
 {This section is optional. Feel free to use some of the text below to help you get started.}
-{Use this section to give more context to the user about what they are about to implement. E.g. explain what OAuth is, how ThirdParty providers work, etc}
+{Use this section to give more context to the user about what they are about to implement. For example, explain what OAuth is, how ThirdParty providers work, etc}
 
 ## Before you start
 

docs/additional-verification/attack-protection-suite/initial-setup.mdx

@@ -21,14 +21,14 @@ The following page shows you how to include the **Attack Protection Suite** feat
 
 This feature is **in beta**.
 To get access to it, please [reach out](mailto:[email protected]) to get it set up for you.
-Once you have access to it, you will receive:
+Once you have access to it, you receive:
 - **Public API key** - use this on your frontend for generating request IDs
 - **Secret API key** - use this on your backend for making requests to the anomaly detection API
 - **Environment ID** - use this for identifying the environment you are using both on the backend and the frontend
 
 
 You can use the feature with either the `Email Password` or the `Passwordless` authentication methods.
-For social or enterprise login, it is not needed for several reasons:
+For social or enterprise login, it is not needed for multiple reasons:
 - **Existing anomaly detection**: Most reputable third-party authentication providers (like Google, Facebook, Apple, etc.) have robust security measures in place, including their own anomaly detection systems. These systems are typically more comprehensive and tailored to their specific platforms.
 - **Limited visibility**: When using third-party authentication, you have limited visibility into the authentication process. This makes it difficult to accurately detect anomalies or suspicious activities that occur on the third-party's side.
 - **Potential false positives**: Applying anomaly detection to third-party logins might lead to an increase in false positives, as you don't have full context of the user's interactions with the third-party provider.
@@ -151,7 +151,7 @@ export const SuperTokensConfig = {
 
 To retrieve the request ID in the backend you have to override the recipe implementations.
 
-#### Email and Password
+#### Email and password
 
 <BackendTabs>
 

docs/additional-verification/mfa/introduction.mdx

@@ -31,7 +31,7 @@ It achieves the same level of security as a magic link.
 ## Getting started
 
 The quickest way to get a glimpse of how MFA works with **SuperTokens** is to use the example app.
-Just run the following command to get started:
+Run the following command to get started:
 
 ```bash
 npx create-supertokens-app@latest --recipe=multifactorauth
@@ -40,7 +40,7 @@ npx create-supertokens-app@latest --recipe=multifactorauth
 Besides that, you can check the initial quickstart guide for step-by-step instructions, along with the other guides for more specific use cases.
 
 Before you explore a guide, read through the **Important Concepts** page first.
-It explains several topics that get used in each tutorial.
+It explains multiple topics that get used in each tutorial.
 
 <ReferenceCard.Grid lg="repeat(2, 1fr)">
   <ReferenceCard href="/docs/additional-verification/mfa/important-concepts">

docs/additional-verification/mfa/legacy-mfa/backend-setup/first-factor.mdx

@@ -25,7 +25,7 @@ After following the [backend quick setup section](/docs/quickstart/backend-setup
 <BackendTabs>
 <BackendTabs.TabItem value="nodejs">
 
-<NodeFrameworksCard showAppTypeSelect>
+<NodeFrameworksCard exclude={["awsLambda", "nextjs", "nestjs"]} showAppTypeSelect>
 <NodeFrameworksCard.Content value="express">
 
 ```tsx
@@ -388,7 +388,7 @@ init(
 You should have also added the SuperTokens `middleware` and `errorHandler` (depending on your framework) to your application. We are not showing it in the above code snippet for brevity, but it is explained in the ThirdParty + EmailPassword recipe guide. 
 :::
 
-## 2. Adding SecondFactorClaim
+## 2. Adding second factor claim
 
 After sign up or sign in of the first factor, the existence of the session signifies the completion of the first factor, but we want to explicitly mark the second factor as incomplete. This can be done by overriding the `createNewSession` function in the `Session.init` config: