Merge branch 'Feat/workflow-docs' into Feat/wf-doc-pic

DaveOrDead · web-flow · commit 55609119a3ca · 2025-04-24T13:29:10.000+10:00
diff --git a/src/content/docs/workflows/about-workflows/index.mdx b/src/content/docs/workflows/about-workflows/index.mdx
@@ -18,9 +18,9 @@ Currently, you can use the following triggers:
 - [user:post_authentication](/workflows/example-workflows/workflow-user-post-auth/) fires after the user has completed single factor authentication (e.g. email + password or Google), and before authorization.
 - [m2m:token_generation](/workflows/example-workflows/m2m-token-generation-workflow/) - when a request to the token endpoint is made with an M2M application.
 - [user:new_password_provided](/workflows/example-workflows/new-password-provided-workflow/) - when a user requests to create or reset a password.
-- [user:existing_password_provided](http://localhost:4321/workflows/example-workflows/existing-password-provided-workflow/) - when a user hasn’t signed in, but they have requested to sign in and given their current password.
-- [user:tokens_generation](/workflows/example-workflows/user-token-generation/) - An ID or access token is generated after authentication or refresh token request.
-- [user:pre_mfa](http://localhost:4321/workflows/example-workflows/pre-mfa-workflow/) - where the user has completed single factor authentication (e.g. email + password or Google) and determined which organization (if any) they are trying to access. This trigger is only available to customers on a Kinde Scale plan.
+- [user:existing_password_provided](/workflows/example-workflows/existing-password-provided-workflow/) - when a user hasn’t signed in, but they have requested to sign in and given their current password.
+- [user:token_generation](/workflows/example-workflows/user-token-generation/) - An ID or access token is generated after authentication or refresh token request.
+- [user:pre_mfa](/workflows/example-workflows/pre-mfa-workflow/) - where the user has completed single factor authentication (e.g. email + password or Google) and determined which organization (if any) they are trying to access. This trigger is only available to customers on a Kinde Scale plan.
 
 We will add more triggers (and allow you to create your own) as we develop the feature.
 
diff --git a/src/content/docs/workflows/bindings/access-token-binding.mdx b/src/content/docs/workflows/bindings/access-token-binding.mdx
@@ -8,7 +8,7 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-The `kinde.accessToken` binding lets you modify access tokens for the current user. Custom claims you add will be included in the access token returned to the client.
+The `kinde.accessToken` binding lets you modify access tokens for the current user. When you add custom claims, they are included in the access token returned to the client.
 
 ## Methods
 
diff --git a/src/content/docs/workflows/bindings/auth-binding.mdx b/src/content/docs/workflows/bindings/auth-binding.mdx
@@ -8,21 +8,21 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-The `kinde.auth` binding lets affect the auth flow.
+The `kinde.auth` binding affects the auth flow.
 
 ## Methods
 
 ### `denyAccess(reason: string): void`
 
-Prevent the user from accessing the application
+Prevent the user from accessing the application.
 
 ## Available in workflows
 
 - [user:post_authentication](/workflows/example-workflows/workflow-user-post-auth/)
 - [user:new_password_provided](/workflows/example-workflows/new-password-provided-workflow/)
-- [user:existing_password_provided](http://localhost:4321/workflows/example-workflows/existing-password-provided-workflow/)
+- [user:existing_password_provided](/workflows/example-workflows/existing-password-provided-workflow/)
 - [user:tokens_generation](/workflows/example-workflows/user-token-generation/)
-- [user:pre_mfa](http://localhost:4321/workflows/example-workflows/pre-mfa-workflow/)
+- [user:pre_mfa](/workflows/example-workflows/pre-mfa-workflow/)
 
 ## Configuration
 
diff --git a/src/content/docs/workflows/bindings/env-binding.mdx b/src/content/docs/workflows/bindings/env-binding.mdx
@@ -24,9 +24,9 @@ Secret variables will be redacted in the logs.
 - [user:post_authentication](/workflows/example-workflows/workflow-user-post-auth/)
 - [m2m:token_generation](/workflows/example-workflows/m2m-token-generation-workflow/)
 - [user:new_password_provided](/workflows/example-workflows/new-password-provided-workflow/)
-- [user:existing_password_provided](http://localhost:4321/workflows/example-workflows/existing-password-provided-workflow/)
+- [user:existing_password_provided](/workflows/example-workflows/existing-password-provided-workflow/)
 - [user:tokens_generation](/workflows/example-workflows/user-token-generation/)
-- [user:pre_mfa](http://localhost:4321/workflows/example-workflows/pre-mfa-workflow/)
+- [user:pre_mfa](/workflows/example-workflows/pre-mfa-workflow/)
 
 ## Configuration
 
@@ -44,7 +44,7 @@ export const workflowSettings = {
 The [Kinde infrastructure library](https://github.com/kinde-oss/infrastructure) provides type-safe environment variable access:
 
 ```js
-import {getEnvironmentVariable} from "@kinde-oss/infrastructure";
+import {getEnvironmentVariable} from "@kinde/infrastructure";
 
 const myVar = getEnvironmentVariable("MY_VAR")?.value;
 ```
diff --git a/src/content/docs/workflows/bindings/fetch-binding.mdx b/src/content/docs/workflows/bindings/fetch-binding.mdx
@@ -8,7 +8,7 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-The `kinde.fetch` binding allows you to make external API calls including the Kinde management API.
+The `kinde.fetch` binding allows you to make external API calls including to the Kinde Management API.
 
 If you are passing sensitive data we recommend you instead use [kinde.secureFetch](/workflows/bindings/secure-fetch-binding/) where the POST body is encrypted.
 
@@ -17,9 +17,9 @@ If you are passing sensitive data we recommend you instead use [kinde.secureFetc
 - [user:post_authentication](/workflows/example-workflows/workflow-user-post-auth/)
 - [m2m:token_generation](/workflows/example-workflows/m2m-token-generation-workflow/)
 - [user:new_password_provided](/workflows/example-workflows/new-password-provided-workflow/)
-- [user:existing_password_provided](http://localhost:4321/workflows/example-workflows/existing-password-provided-workflow/)
+- [user:existing_password_provided](/workflows/example-workflows/existing-password-provided-workflow/)
 - [user:tokens_generation](/workflows/example-workflows/user-token-generation/)
-- [user:pre_mfa](http://localhost:4321/workflows/example-workflows/pre-mfa-workflow/)
+- [user:pre_mfa](/workflows/example-workflows/pre-mfa-workflow/)
 
 ## Configuration
 
@@ -39,7 +39,7 @@ The [Kinde infrastructure library](https://github.com/kinde-oss/infrastructure)
 Note: you will also need the [url](/workflows/bindings/url-binding/) binding enabled for the workflow as this is used under the hood.
 
 ```js
-import {fetch} from "@kinde-oss/infrastructure";
+import {fetch} from "@kinde/infrastructure";
 
 export default async function Workflow(event) {
   const {data: ipDetails} = await fetch(
diff --git a/src/content/docs/workflows/bindings/id-token-binding.mdx b/src/content/docs/workflows/bindings/id-token-binding.mdx
@@ -8,7 +8,7 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-The `kinde.idToken` binding lets you modify ID tokens for the current user. Custom claims you add will be included in the ID token returned to the client.
+The `kinde.idToken` binding lets you modify ID tokens for the current user. When you add custom claims, these are included in the ID token returned to the client.
 
 ## Methods
 
diff --git a/src/content/docs/workflows/bindings/index.mdx b/src/content/docs/workflows/bindings/index.mdx
@@ -13,7 +13,7 @@ Bindings allow your workflow code to interact with resources within the Kinde in
 
 ## Available bindings
 
-The following bindings available today, but may only be available within certain workflow contexts. You'll need to check the documenation for each workflow trigger to see which bindings are available to it.
+The following bindings are available. Only some are available within specific workflow contexts. Check the documentation to confirm which bindings are available for each workflow trigger.
 
 ### Kinde specific bindings:
 
@@ -23,7 +23,7 @@ The following bindings available today, but may only be available within certain
 - [kinde.fetch](/workflows/bindings/fetch-binding/)
 - [kinde.idToken](/workflows/bindings/id-token-binding/)
 - [kinde.m2mToken](/workflows/bindings/m2m-token-binding/)
-- [kinde.mfa](/workflows/bindings/mfa-token-binding/)
+- [kinde.mfa](/workflows/bindings/mfa-binding/)
 - [kinde.secureFetch](/workflows/bindings/secure-fetch-binding/)
 
 ### Native bindings
diff --git a/src/content/docs/workflows/bindings/m2m-token-binding.mdx b/src/content/docs/workflows/bindings/m2m-token-binding.mdx
@@ -8,13 +8,13 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-The `kinde.m2mToken` binding lets you modify M2M (machine-to-machine) tokens. Custom claims you add will be included in the M2M token returned to the client.
+The `kinde.m2mToken` binding lets you modify M2M (machine-to-machine) tokens. When you add custom claims, these are included in the M2M token returned to the client.
 
 ## Methods
 
 ### `setCustomClaim(name: string, value: any): void`
 
-Adds a custom claim to the M2M token. The claim will be available when the token is returned to the client.
+Adds a custom claim to the M2M token. The claim is available when the token is returned to the client.
 
 ## Available in workflows
 
diff --git a/src/content/docs/workflows/bindings/mfa-binding.mdx b/src/content/docs/workflows/bindings/mfa-binding.mdx
@@ -8,7 +8,7 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-The `kinde.mfa` binding lets carry out MFA related operations
+The `kinde.mfa` binding lets you perform MFA-related operations.
 
 ## Methods
 
@@ -18,7 +18,7 @@ Allows you to set the MFA enforcement policy for the user for the current auth f
 
 ## Available in workflows
 
-- [user:pre_mfa](http://localhost:4321/workflows/example-workflows/pre-mfa-workflow/)
+- [user:pre_mfa](/workflows/example-workflows/pre-mfa-workflow/)
 
 ## Configuration
 
diff --git a/src/content/docs/workflows/bindings/secure-fetch-binding.mdx b/src/content/docs/workflows/bindings/secure-fetch-binding.mdx
@@ -9,16 +9,16 @@ relatedArticles:
   - 3f0159e8-17dd-4adb-ab12-ab53c901cf83
 ---
 
-The `kinde.secureFetch` binding allows you to make POST requests to external APIs where the payload is encrypted with the [workflow encryption key](/workflows/manage-workflows/workflow-encryption-key/) you have previously set up in Kinde.
+The `kinde.secureFetch` binding allows you to make POST requests to external APIs where the payload is encrypted with the [workflow encryption key](/workflows/manage-workflows/workflow-encryption-key/) you've previously set up in Kinde.
 
 ## Available in workflows
 
 - [user:post_authentication](/workflows/example-workflows/workflow-user-post-auth/)
 - [m2m:token_generation](/workflows/example-workflows/m2m-token-generation-workflow/)
 - [user:new_password_provided](/workflows/example-workflows/new-password-provided-workflow/)
-- [user:existing_password_provided](http://localhost:4321/workflows/example-workflows/existing-password-provided-workflow/)
+- [user:existing_password_provided](/workflows/example-workflows/existing-password-provided-workflow/)
 - [user:tokens_generation](/workflows/example-workflows/user-token-generation/)
-- [user:pre_mfa](http://localhost:4321/workflows/example-workflows/pre-mfa-workflow/)
+- [user:pre_mfa](/workflows/example-workflows/pre-mfa-workflow/)
 
 ## Configuration
 
@@ -38,7 +38,7 @@ The [Kinde infrastructure library](https://github.com/kinde-oss/infrastructure)
 Note: you will also need the [url](/workflows/bindings/url-binding/) binding enabled for the workflow as this is used under the hood.
 
 ```js
-import {fetch} from "@kinde-oss/infrastructure";
+import {fetch} from "@kinde/infrastructure";
 
 export default async function Workflow(event) {
   const {data} = await secureFetch(`https://api.somethingsecret.com/api`, {
diff --git a/src/content/docs/workflows/bindings/url-binding.mdx b/src/content/docs/workflows/bindings/url-binding.mdx
@@ -8,16 +8,16 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-The `url` binding allows you to access the native JavaScript `URLSearchParams` API. This is useful for parsing and manipulating URLs in your workflow and is often used in conjustion with the [kinde.fetch](/workflows/bindings/fetch-binding/) binding.
+The `url` binding allows you to access the native JavaScript `URLSearchParams` API. This is useful for parsing and manipulating URLs in your workflow and is often used in conjunction with the [kinde.fetch](/workflows/bindings/fetch-binding/) binding.
 
 ## Available in workflows
 
 - [user:post_authentication](/workflows/example-workflows/workflow-user-post-auth/)
 - [m2m:token_generation](/workflows/example-workflows/m2m-token-generation-workflow/)
 - [user:new_password_provided](/workflows/example-workflows/new-password-provided-workflow/)
-- [user:existing_password_provided](http://localhost:4321/workflows/example-workflows/existing-password-provided-workflow/)
+- [user:existing_password_provided](/workflows/example-workflows/existing-password-provided-workflow/)
 - [user:tokens_generation](/workflows/example-workflows/user-token-generation/)
-- [user:pre_mfa](http://localhost:4321/workflows/example-workflows/pre-mfa-workflow/)
+- [user:pre_mfa](/workflows/example-workflows/pre-mfa-workflow/)
 
 ## Configuration
 
diff --git a/src/content/docs/workflows/configuration/bindings.mdx b/src/content/docs/workflows/configuration/bindings.mdx
@@ -11,7 +11,7 @@ relatedArticles:
 
 Bindings allow your workflow code to interact with resources within the Kinde infrastructure.
 
-When you declare a binding in your workflow, you grant it a specific capability, such as being able to access environment variables, or add claims to an access token. For example:
+When you declare a binding in your workflow, you grant it a specific capability, such as being able to access environment variables or add claims to an access token. For example:
 
 ```js
 export const workflowSettings: WorkflowSettings = {
@@ -22,11 +22,11 @@ export const workflowSettings: WorkflowSettings = {
 };
 ```
 
-If a binding is not declared and you try to use it in the workflow it will result in a runtime error.
+If a binding is not declared and you try to use it in the workflow, you'll get a runtime error.
 
 ## Available bindings
 
-The following bindings available today, but may only be available within certain workflow contexts. You'll need to check the documenation for each workflow trigger to see which bindings are available to it.
+The following bindings available, but only within certain workflow contexts. Check the documentation to see which bindings are available for each workflow trigger.
 
 ### Kinde specific bindings:
 
@@ -36,7 +36,7 @@ The following bindings available today, but may only be available within certain
 - [kinde.fetch](/workflows/bindings/fetch-binding/)
 - [kinde.idToken](/workflows/bindings/id-token-binding/)
 - [kinde.m2mToken](/workflows/bindings/m2m-token-binding/)
-- [kinde.mfa](/workflows/bindings/mfa-token-binding/)
+- [kinde.mfa](/workflows/bindings/mfa-binding/)
 - [kinde.secureFetch](/workflows/bindings/secure-fetch-binding/)
 
 ### Native bindings
diff --git a/src/content/docs/workflows/configuration/dependencies.mdx b/src/content/docs/workflows/configuration/dependencies.mdx
@@ -9,11 +9,11 @@ relatedArticles:
   - 5917da0f-24f0-48df-a387-aca03ce1fe7a
 ---
 
-It's important to understand that Kinde's workflow runtime operates differently from Node.js — it provides a secure, restricted JavaScript environment with access only to a predefined set of trusted packages.
+Kinde's workflow runtime operates differently from Node.js. Workflows provide a secure, restricted JavaScript environment with access only to a pre-defined set of trusted packages.
 
 While Kinde doesn't require a `package.json` file by default, you'll need one if you want to use third-party libraries whilst developing your workflow code.
 
-## Setting up package.json
+## Set up package.json
 
 To include third-party libraries in your workflow:
 
diff --git a/src/content/docs/workflows/configuration/environment-variables-and-secrets.mdx b/src/content/docs/workflows/configuration/environment-variables-and-secrets.mdx
@@ -9,7 +9,7 @@ relatedArticles:
   - bb85aaa0-840c-461a-b422-b346e0f14250
 ---
 
-You can set up environment variables and secrets in Kinde to use in your workflow code. This is useful for storing sensitive information, such as API keys or database credentials, that you don't want to hard-code into your workflow files.
+You can set up environment variables and secrets in Kinde to use in your workflow code. This is useful for storing sensitive information, such as API keys or database credentials that you don't want to hard-code into your workflow files.
 
 ## Creating environment variables
 
@@ -19,10 +19,10 @@ You can create environment variables in the [Kinde admin area](/build/env-variab
 
 The `kinde.env` binding must be enabled in your workflow file to use environment variables.
 
-If you are using the Kinde infrastructure library it provides a helper method to access environment variables:
+If you are using the Kinde infrastructure library, it provides a helper method to access environment variables:
 
 ```js
-import {getEnvironmentVariable} from "@kinde-oss/infrastructure";
+import {getEnvironmentVariable} from "@kinde/infrastructure";
 const myVar = getEnvironmentVariable("MY_VAR")?.value;
 ```
 
@@ -32,4 +32,4 @@ If you are not using the Kinde infrastructure library, you can access environmen
 
 ## process.env
 
-Kinde is not a Node runtime so the `process` object is not available. Instead, you access environment variables using the methods laid out above.
+Kinde is not a Node runtime so the `process` object is not available. Instead, you access environment variables using the methods described above.
diff --git a/src/content/docs/workflows/example-workflows/new-password-provided-workflow.mdx b/src/content/docs/workflows/example-workflows/new-password-provided-workflow.mdx
@@ -96,6 +96,7 @@ if (!isMinCharacters) {
     "Provide a password at least 50 characters long"
   );
 }
+
 ```
 
 The field names for the widget binding in this workflow are:
@@ -111,3 +112,4 @@ See examples on GitHub:
 
 - [Sync passwords to another system](https://github.com/kinde-starter-kits/workflow-examples/blob/main/newPassword/securelySyncPasswordWorkflow.ts) - Use encryption keys to securely keep passwords in sync between systems.
 - [Custom password validation](https://github.com/kinde-starter-kits/workflow-examples/blob/main/newPassword/customPasswordValidationWorkflow.ts) - Shows how to validate a password against your own rules.
+
diff --git a/src/content/docs/workflows/manage-workflows/workflow-encryption-key.mdx b/src/content/docs/workflows/manage-workflows/workflow-encryption-key.mdx
@@ -24,7 +24,7 @@ When an POST request is made using the [kinde.secureFetch binding](/workflows/bi
 1. Go to **Workflows** and select a workflow.
 2. Select **Encryption keys** in the menu.
 3. Select **Add encryption key**. A dialog appears, enabling you to copy the key. You need to copy it immediately, as it cannot be viewed again.
-4. After you copy the key, select **Close**. If this is the fist key you have added, it will automatically be made **active**.
+4. After you copy the key, select **Close**. If this is the first key you have added, it will automatically be made **active**.
 5. Add the key to your code, to decrypt data sent from Kinde.
 
 ## Update an encryption key
@@ -56,7 +56,7 @@ You can change the active status of any key. Remember to update your code to use
 
 ## Delete used or unwanted encryption keys
 
-Deleting used keys is good security hygeiene. But deleting an active key can also break your code. Only delete inactive keys.
+Deleting used keys is good security hygiene. But deleting an active key can also break your code. Only delete inactive keys.
 
 1. Go to **Workflows** and select a workflow.
 2. Select **Encryption keys** in the menu.
