Skip to content

Commit b13e7b6

Browse files
authored
Merge pull request #576 from devforth/next
Next
2 parents a9707e8 + bddb407 commit b13e7b6

35 files changed

Lines changed: 220 additions & 66 deletions

AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@
66
All packages and projects in this repo use `pnpm` and not `npm`.
77
Howeverer internally (e.g. in `codeInjector`) adminforth still supports both `npm` and `pnpm` style install commands, so users of framework itself can use it with either package manager. But in all dev demo/live demo, plugins, adapters, and documentation, we use `pnpm` as the standard.
88

9+
## Package names rules
10+
11+
12+
All adapters and plugins always have `@adminforth/` prefix in their package name, followed by short lowercase kebab-case plugin/adpater slug.
13+
14+
Every plugin has at least one Docusaurus docs page, which should use the path `/docs/tutorial/Plugins/<plugin-slug>/`.
15+
16+
Same for adapters, but with `/docs/tutorial/Adapters/<adapter-slug>/` path.
17+
18+
Page names in docusarus should be human readabale. We should not use `AuditLog` but instead we should have `Audit Log` via whitespace.
19+
20+
921
## General engineering rules
1022

1123
Write code as if the system contracts are already defined and trusted.

adminforth/documentation/docs/tutorial/03-Customization/04-hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ When user opens edit page, AdminForth makes a request to the backend to get the
4444

4545
Practically you can use `show.afterDatasourceResponse` to modify or add some data before it is displayed on the edit page.
4646

47-
For example [upload plugin](/docs/tutorial/Plugins/05-0-upload/) uses this hook to generate signed preview URL so user can see existing uploaded file preview in form, and at the same time database stores only original file path which might be not accessible without presigned URL.
47+
For example [upload plugin](/docs/tutorial/Plugins/upload/) uses this hook to generate signed preview URL so user can see existing uploaded file preview in form, and at the same time database stores only original file path which might be not accessible without presigned URL.
4848

4949
## Saving data on edit page
5050

adminforth/documentation/docs/tutorial/03-Customization/10-menuConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ auth: {
277277

278278
```
279279

280-
This syntax can be use to get unique avatar for each user of hardcode avatar, but it makes more sense to use it with [upload plugin](https://adminforth.dev/docs/tutorial/Plugins/05-0-upload/#using-plugin-for-uploading-avatar)
280+
This syntax can be use to get unique avatar for each user of hardcode avatar, but it makes more sense to use it with [upload plugin](https://adminforth.dev/docs/tutorial/Plugins/upload/#using-plugin-for-uploading-avatar)
281281

282282

283283
## Custom URL

adminforth/documentation/docs/tutorial/08-Plugins/01-AuditLog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Audit Log
3+
slug: /tutorial/Plugins/audit-log
4+
---
15

26
AuditLog plugin allows to log all changes in the resources done from the admin panel.
37
It will allow you to figure out who and when made changes in the data.

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Two-Factor Authentication Plugin
3+
slug: /tutorial/Plugins/two-factors-auth
4+
---
5+
16
# Two-Factor Authentication Plugin
27

38
The Two-Factor Authentication Plugin provides an additional layer of security to the application by requiring users to provide a second form of authentication in addition to their password. This plugin supports authenticator apps.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Foreign Inline List
3+
slug: /tutorial/Plugins/foreign-inline-list
4+
---
15

26
Foreign inline list plugin allows to display a list (table) of items from a foreign table in the show view.
37

adminforth/documentation/docs/tutorial/08-Plugins/04-RichEditor.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Rich Editor
3+
slug: /tutorial/Plugins/rich-editor
4+
---
5+
16
# Rich editor
27

38
Under the hood this plugin uses [Quill](https://quilljs.com/). Quill is a free, open source WYSIWYG editor built for the modern web.

adminforth/documentation/docs/tutorial/08-Plugins/05-0-upload.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Upload
3+
slug: /tutorial/Plugins/upload
4+
---
5+
16
# Upload
27

38
This plugin allows you to upload files to Amazon S3 bucket.

adminforth/documentation/docs/tutorial/08-Plugins/06-text-complete.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Text Complete
3+
slug: /tutorial/Plugins/text-complete
4+
---
5+
16
# Text Complete
27

38
This plugin allows you to auto-complete text and string fields using OpenAI GPT models via the Responses API.

adminforth/documentation/docs/tutorial/08-Plugins/07-email-password-reset.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Email Password Reset
3+
slug: /tutorial/Plugins/email-password-reset
4+
---
15

26
# Email password reset
37

0 commit comments

Comments
 (0)