# magefan/module-admin-user-guide

> Admin panel user guides.

`composer require magefan/module-admin-user-guide`

Canonical URL: https://packagento.com/magefan/module-admin-user-guide

## At a glance

- **Vendor**: magefan (https://packagento.com/magefan.md)
- **Latest version**: 2.0.7 — released 2025-11-14
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/magefan/module-admin-user-guide and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require magefan/module-admin-user-guide:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Admin panel user guides.

## README

[![Total Downloads](https://poser.pugx.org/magefan/module-admin-user-guide/downloads)](https://packagist.org/packages/magefan/module-admin-user-guide)
[![Latest Stable Version](https://poser.pugx.org/magefan/module-admin-user-guide/v/stable)](https://packagist.org/packages/magefan/module-admin-user-guide)

This Magento 2 Admin User Guide module adds guide links in admin panel to improve admin experience.

### 🇺🇦 Stand with Ukraine! [How can you help?](https://magefan.com/blog/join-our-donations)

### Requirements
  * Magento Community Edition 2.1.x-2.4.x or Magento Enterprise Edition 2.1.x-2.4.x

### Installation Method 1 - Installing via composer
  * Open command line
  * Using command "cd" navigate to your magento2 root directory
  * Run command: composer require magefan/module-admin-user-guide

  

### Installation Method 2 - Installing using archive
  * Download [ZIP Archive](https://github.com/magefan/module-admin-user-guide/archive/refs/heads/main.zip)
  * Extract files
  * In your Magento 2 root directory create folder app/code/Magefan/AdminUserGuide
  * Copy files and folders from archive to that folder
  * In command line, using "cd", navigate to your Magento 2 root directory
  * Run commands:
```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```

### Support
If you have any issues, please [contact us](mailto:support@magefan.com)
then if you still need help, open a bug report in GitHub's
[issue tracker](https://github.com/magefan/module-admin-user-guide/issues).

Please do not use Magento Marketplace Reviews or (especially) the Q&A for support.
There isn't a way for us to reply to reviews and the Q&A moderation is very slow.

### Need More Features?
Please contact us to get a quote
https://magefan.com/contact

### License
The code is licensed under [EULA](https://magefan.com/end-user-license-agreement).

### [Magento 2 Extensions](https://magefan.com/magento-2-extensions) by Magefan

#### [Magento 2 Google Extensions](https://magefan.com/magento-2-extensions/google-extensions)

  * [Magento 2 Google Indexing](https://magefan.com/magento-2-google-indexing-api)
  * [Magento 2 Google Analytics 4](https://magefan.com/magento-2-google-analytics-4)
  * [Magento 2 Google Tag Manager](https://magefan.com/magento-2-google-tag-manager)
  * [Magento 2 Google Shopping Feed](https://magefan.com/magento-2-google-shopping-feed-extension)
  * [Magento 2 Google Customer Reviews](https://magefan.com/magento-2-google-customer-reviews)

#### Magento 2 SEO Extensions

  * [Magento 2 SEO Extension](https://magefan.com/magento-2-seo-extension)
  * [Magento 2 Rich Snippets](https://magefan.com/magento-2-rich-snippets)
  * [Magento 2 HTML Sitemap](https://magefan.com/magento-2-html-sitemap-extension)
  * [Magento 2 XML Sitemap](https://magefan.com/magento-2-xml-sitemap-extension)
  * [Magento 2 Facebook Open Graph](https://magefan.com/magento-2-open-graph-extension-og-tags)
  * [Magento 2 Twitter Cards](https://magefan.com/magento-2-twitter-cards-extension)


#### [Magento 2 Speed Optimization Extensions](https://magefan.com/magento-2-extensions/speed-optimization)

  * [Magento 2 Google Page Speed Optimizer](https://magefan.com/magento-2-google-page-speed-optimizer)
  * [Magento 2 Full Page Cache Warmer](https://magefan.com/magento-2-full-page-cache-warmer)
  * [Magento 2 Image Lazy Load](https://magefan.com/magento-2-image-lazy-load-extension)
  * [Magento 2 WebP Images](https://magefan.com/magento-2-webp-optimized-images)
  * [Magento 2 Rocket JavaScript](https://magefan.com/rocket-javascript-deferred-javascript)

  ### [Magento 2 Admin Panel Extensions](https://magefan.com/magento-2-extensions/admin-extensions)

  * [Magento 2 Size Chart Extension](https://magefan.com/magento-2-size-chart)
  * [Magento 2 Security Extension](https://magefan.com/magento-2-security-extension)
  * [Magento 2 Admin Action Log](https://magefan.com/magento-2-admin-action-log)
  * [Magento 2 Order Editor](https://magefan.com/magento-2-edit-order-extension)
  * [Magento 2 Better Order Grid](https://magefan.com/magento-2-better-order-grid-extension)
  * [Magento 2 Extended Product Grid](https://magefan.com/magento-2-product-grid-inline-editor)
  * [Magento 2 Product Tabs](https://magefan.com/magento-2/extensions/product-tabs)
  * [Magento 2 Facebook Pixel](https://magefan.com/magento-2-facebook-pixel-extension)
  * [Magento 2 Email Attachments](https://magefan.com/magento-2-email-attachments)
  * [Magento 2 Admin View](https://magefan.com/magento-2-admin-view-extension)
  * [Magento 2 Admin Email Notifications](https://magefan.com/magento-2-admin-email-notifications)
  * [Magento 2 Login As Customer](https://magefan.com/login-as-customer-magento-2-extension)

#### Magento 2 Blog Extensions

  * [Magento 2 Blog](https://magefan.com/magento2-blog-extension)
  * [Magento 2 Multi Blog](https://magefan.com/magento-2-multi-blog-extension)
  * [Magento 2 Product Widget](https://magefan.com/magento-2-product-widget)

#### [Magento 2 Marketing Automation Extensions](https://magefan.com/magento-2-extensions/marketing-automation)

  * [Magento 2 Cookie Consent](https://magefan.com/magento-2-cookie-consent)
  * [Magento 2 Product Labels](https://magefan.com/magento-2-product-labels)
  * [Magento 2 Base Price](https://magefan.com/magento-2-base-price)
  * [Magento 2 Dynamic Categories](https://magefan.com/magento-2-dynamic-categories)
  * [Magento 2 Dynamic Blocks and Pages Extension](https://magefan.com/magento-2-cms-display-rules-extension)
  * [Magento 2 Automatic Related Products](https://magefan.com/magento-2-automatic-related-products)
  * [Magento 2 Price History](https://magefan.com/magento-2-price-history)
  * [Magento 2 Mautic Integration](https://magefan.com/magento-2-mautic-extension)
  * [Magento 2 YouTube Video](https://magefan.com/magento2-youtube-extension)    
 
#### [Magento 2 Cart Extensions](https://magefan.com/magento-2-extensions/cart-extensions)

_(README truncated for .md surface. Full README on https://packagento.com/magefan/module-admin-user-guide.)_

## Recent Versions

| Version | Released |
|---|---|
| 2.0.7 | 2025-11-14 |
| 2.0.6 | 2025-01-29 |
| 2.0.5 | 2025-01-24 |
| 2.0.4 | 2024-07-05 |
| 2.0.3 | 2023-05-21 |
| 2.0.2 | 2023-03-03 |
| 2.0.1 | 2021-12-30 |
| 2.0.0 | 2021-12-03 |

## Quality

Latest release (2.0.7) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 |  |
| PHPMD | Warning | 2 | 2 rule violations (CyclomaticComplexity:1, NPathComplexity:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 2 | 2 | – | – |
| 2.4.8 | – | 2 | 2 | – |
| 2.4.9 | – | – | 2 | 2 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["magefan/module-admin-user-guide"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

magefan is a Magento 2 vendor on Packagento. See https://packagento.com/magefan.md for their full catalogue.