exfabrica / strapi-plugin-awesome-help

This plugin enable creation of contextual helps for your Strapi documents!

Strapi plugin Awesome Help

This plugin is not intended to be used in production. This is a learning aid. Nevertheless, we will try to go as far as possible in its design and deployment.

This plugin includes all code you need to follow this technical articles: A Strapi plugin from scratch to production

• DESCRIPTION
• FEATURES
• INSTALLATION
• CONFIGURATION

DESCRIPTION

The purpose of this plugin is to display an icon on each form label present in each document to display contextual help. When the user over the icon, the plugin displays a tooltip with a helpful text.

FEATURES

• Add contextual Help on your Strapi documents.
• Scan the Strapi Structure to get all textual and numerical fields.

INSTALLATION

#npm
npm install @exfabrica/strapi-plugin-awesome-help

#yarn
yarn add @exfabrica/strapi-plugin-awesome-help

CONFIGURATION

Just go inside the general settings of Awesome Help to enable / disable the contextual help.

strapi-plugin-awesome-help's Issues

no possibility to add tooltip to photos

It would be good to be able to add a tooltip to photos

Can't resolve strapi-list-zone-item

After install and build project have error
Can't resolve './components/injected/strapi-list-zone-item' in '/home/wsl/Projects/@/media/node_modules/@exfabrica/strapi-plugin-awesome-help/admin/src'

You source code have a line https://github.com/ExFabrica/strapi-plugin-awesome-help/blob/main/admin/src/index.js#L10
with wrong import path
Directory is Injected not injected

Does this work with V4?

Hi,

I installed the plugin on Strapi v4.8.2 and I even enabled it from config/plugins.ts

The plugin is listed in /admin/list-plugins however I cannot see its menu under the Media Library, nor the settings panel

Is this plugin compatible with V4? Or am I doing something wrong?

How to change the info icon.

How to change the info icon currently getting the question mark or how to extend this plugin

Tooltip only goes two levels deep

Hello!

I wanted to suggest adding a feature for the tooltip to work with nested components.
For example: api::hr-section.hr-section/sections/why-join-us/description <- writing on this field works

But levels deeper than that, won't work: api::hr-section.hr-section/hr-sections/why-join-us/cards/description and it breaks the application

Thanks! ;)

Does not work for boolean fields

I can't add tooltips for my boolean fields.

Doesn't run with the latest Strapi 4.17.0

Creating admin[ERROR] Module not found: Error: Can't resolve '@strapi/design-system/Portal' in '/xxx/xxx/development/xxx/app/node_modules/@exfabrica/strapi-plugin-awesome-help/admin/src/components/Injected'
[ERROR] There seems to be an unexpected error, try again with --debug for more information

[ERROR] Command failed with exit code 1: /xxx/xxx/.nvm/versions/node/v18.18.2/bin/node /home/xxx/development/xxx/app/node_modules/.bin/strapi develop

Add support for json fields

Could it be possible to add this feature for json fields ? They are the one which usually require extensive documentation to avoid making mistake

There is no "Scan your Strapi internal structure" button inside admin and all fields information

"dependencies": {
    "@exfabrica/strapi-plugin-awesome-help": "^1.0.8",
    "@notum-cz/strapi-plugin-content-versioning": "^0.4.0",
    "@strapi/plugin-graphql": "4.2.0",
    "@strapi/plugin-i18n": "4.2.0",
    "@strapi/plugin-sentry": "4.2.0",
    "@strapi/plugin-seo": "^1.7.2",
    "@strapi/plugin-users-permissions": "4.2.0",
    "@strapi/strapi": "4.2.0",
    "react-if": "^4.1.4",
    "sqlite3": "^5.0.5",
    "strapi-plugin-comments": "^2.1.7",
    "strapi-plugin-config-sync": "^1.0.1",
    "strapi-plugin-placeholder": "^4.1.7",
    "strapi-plugin-preview-button": "^0.3.4",
    "strapi-plugin-rest-cache": "^4.2.4",
    "strapi-plugin-slugify": "^2.2.2",
    "strapi-provider-rest-cache-memory": "^4.2.4"
  }

"engines": {
    "node": ">=12.x.x <=16.x.x",
    "npm": ">=6.0.0"
  }