Skip to content

Commit 31163a5

Browse files
committed
docs: correct install with pnpm command in docs examples (pnpm install doesnt update package.json, it only adds file to the node modules)
AdminForth/1796/image
1 parent 9c41cc6 commit 31163a5

33 files changed

Lines changed: 71 additions & 71 deletions

adminforth/documentation/docs/tutorial/06-Adapters/01-email-adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Used to send emails.
1111
## AWS SES Email Adapter
1212

1313
```bash
14-
pnpm i @adminforth/email-adapter-aws-ses
14+
pnpm add @adminforth/email-adapter-aws-ses
1515
```
1616

1717
Enables email delivery via [Amazon Simple Email Service (SES)](https://aws.amazon.com/ses/), suitable for high-volume, programmatic email sending.
1818

1919
## Mailgun Email Adapter
2020

2121
```bash
22-
pnpm i @adminforth/email-adapter-mailgun
22+
pnpm add @adminforth/email-adapter-mailgun
2323
```
2424

2525
Allows sending transactional or marketing emails using [Mailgun](https://www.mailgun.com/), a developer-friendly email service.

adminforth/documentation/docs/tutorial/06-Adapters/02-oauth2-adapters.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,55 +11,55 @@ Used to authenticate users via OAuth 2.0 providers.
1111
## Google OAuth Adapter
1212

1313
```bash
14-
pnpm i @adminforth/oauth-adapter-google
14+
pnpm add @adminforth/oauth-adapter-google
1515
```
1616

1717
Supports Google sign-in to allow users to authenticate using their Google or Google Workspaces accounts.
1818

1919
## GitHub OAuth Adapter
2020

2121
```bash
22-
pnpm i @adminforth/oauth-adapter-github
22+
pnpm add @adminforth/oauth-adapter-github
2323
```
2424

2525
Enables authentication via GitHub accounts, useful for developer tools and open-source apps.
2626

2727
## Facebook OAuth Adapter
2828

2929
```bash
30-
pnpm i @adminforth/oauth-adapter-facebook
30+
pnpm add @adminforth/oauth-adapter-facebook
3131
```
3232

3333
Allows users to log in with Facebook credentials. Facebook OAuth is commonly used for social media integrations.
3434

3535
## Keycloak OAuth Adapter
3636

3737
```bash
38-
pnpm i @adminforth/oauth-adapter-keycloak
38+
pnpm add @adminforth/oauth-adapter-keycloak
3939
```
4040

4141
Connects AdminForth to an open-source [Keycloak](https://www.keycloak.org/) identity provider for enterprise-grade SSO (Single Sign-On).
4242

4343
## Microsoft OAuth Adapter
4444

4545
```bash
46-
pnpm i @adminforth/oauth-adapter-microsoft
46+
pnpm add @adminforth/oauth-adapter-microsoft
4747
```
4848

4949
Supports login through Microsoft accounts including Azure AD, Office365, and Outlook.com.
5050

5151
## Twitch OAuth Adapter
5252

5353
```bash
54-
pnpm i @adminforth/oauth-adapter-twitch
54+
pnpm add @adminforth/oauth-adapter-twitch
5555
```
5656

5757
Adds support for Twitch authentication, useful for streaming or creator-oriented platforms.
5858

5959
## Clerk OAuth Adapter
6060

6161
```bash
62-
pnpm i @adminforth/oauth-adapter-clerk
62+
pnpm add @adminforth/oauth-adapter-clerk
6363
```
6464

6565
Enables sign-in via [Clerk](https://clerk.com/) — a hosted authentication platform with built-in user management, MFA, and social logins.

adminforth/documentation/docs/tutorial/06-Adapters/03-image-generation-adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Used for image-generating AI tools.
1111
## OpenAI Image Generation Adapter
1212

1313
```bash
14-
pnpm i @adminforth/image-generation-adapter-openai
14+
pnpm add @adminforth/image-generation-adapter-openai
1515
```
1616

1717
Uses OpenAI image generation models such as DALL·E, `gpt-image-1`, and `gpt-image-1.5` to generate images from text prompts.
@@ -21,7 +21,7 @@ Up to the winter 2026 OpenAI models are one of the most powerful image generatio
2121
## Gemini (Nano Banana) Image Generation Adapter
2222

2323
```bash
24-
pnpm i @adminforth/image-generation-adapter-nano-banana
24+
pnpm add @adminforth/image-generation-adapter-nano-banana
2525
```
2626

2727
Uses the latest `gemini-3.1-flash-image-preview` model for instant image generation with text descriptions.

adminforth/documentation/docs/tutorial/06-Adapters/05-ai-completion-adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Then output will be like:
105105
## OpenAI Responses Completion Adapter
106106

107107
```bash
108-
pnpm i @adminforth/completion-adapter-openai-responses
108+
pnpm add @adminforth/completion-adapter-openai-responses
109109
```
110110

111111
Integrates AdminForth with OpenAI's Responses API to provide AI-powered completion and conversational features.
@@ -167,7 +167,7 @@ We recommend you to try responses API first by setting `false` in `useCompletion
167167
## Google Gemini Completion Adapter
168168

169169
```bash
170-
pnpm i @adminforth/completion-adapter-google-gemini
170+
pnpm add @adminforth/completion-adapter-google-gemini
171171
```
172172

173173
Integrates AdminForth with Google Gemini models to provide AI-powered completion and conversational features.

adminforth/documentation/docs/tutorial/06-Adapters/06-image-analysis-adapters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ These adapters can analyze image content, extract text from images, identify obj
1313
## OpenAI Vision Adapter
1414

1515
```bash
16-
pnpm install @adminforth/image-vision-adapter-openai --save
16+
pnpm add @adminforth/image-vision-adapter-openai --save
1717
```
1818

1919
Integrates AdminForth with OpenAI to provide advanced AI-powered image analysis. It can describe image content, read and extract text from images, identify objects and people, and provide detailed visual insights.

adminforth/documentation/docs/tutorial/06-Adapters/08-captcha-adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Used to add captcha to the login screen.
1111
## Cloudflare Adapter
1212

1313
```bash
14-
pnpm i @adminforth/login-captcha-adapter-cloudflare
14+
pnpm add @adminforth/login-captcha-adapter-cloudflare
1515
```
1616

1717
## reCaptcha Adapter
1818

1919
```bash
20-
pnpm i @adminforth/login-captcha-adapter-recaptcha
20+
pnpm add @adminforth/login-captcha-adapter-recaptcha
2121
```

adminforth/documentation/docs/tutorial/06-Adapters/09-chat-surface-adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Chat surface adapters connect external chat products to the [Agent plugin](/docs
1212
For Telegram you need both adapters:
1313

1414
```bash
15-
pnpm i @adminforth/chat-surface-adapter-telegram
16-
pnpm i @adminforth/oauth-adapter-telegram
15+
pnpm add @adminforth/chat-surface-adapter-telegram
16+
pnpm add @adminforth/oauth-adapter-telegram
1717
```
1818

1919
Create a Telegram bot with BotFather and copy the token:

adminforth/documentation/docs/tutorial/09-Plugins/02-TwoFactorsAuth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Also it supports both:
2323
## Installation
2424

2525
``` bash
26-
pnpm i @adminforth/two-factors-auth --save
26+
pnpm add @adminforth/two-factors-auth --save
2727
```
2828

2929
To import:
@@ -847,7 +847,7 @@ Add the new resource to index.ts:
847847
```
848848
To use passkey you need to use Key-Value adapter. For example:
849849
```bash
850-
pnpm i @adminforth/key-value-adapter-ram
850+
pnpm add @adminforth/key-value-adapter-ram
851851
```
852852
853853

adminforth/documentation/docs/tutorial/09-Plugins/03-ForeignInlineList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Foreign inline list plugin allows to display a list (table) of items from a fore
1212
Import plugin:
1313

1414
```bash
15-
pnpm i @adminforth/foreign-inline-list --save
15+
pnpm add @adminforth/foreign-inline-list --save
1616
```
1717

1818
```ts title="./resources/adminuser.ts"

adminforth/documentation/docs/tutorial/09-Plugins/04-AuditLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Requires separate table in the database to store logs.
1212

1313

1414
```bash
15-
pnpm i @adminforth/audit-log --save
15+
pnpm add @adminforth/audit-log --save
1616
```
1717

1818
Create `auditLogs.ts` in `resources` folder:

0 commit comments

Comments
 (0)