# Admin Help

## Package docs status

This page is generated from package source documentation in `the Capell packages repository` and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

| Field | Value |
| --- | --- |
| Composer package | `capell-app/admin-help` |
| Package slug | `admin-help` |
| Product group | Capell Essentials |
| Tier | free |
| Bundle | `foundation` |
| Runtime contexts | `admin` |
| Capell version | `^1.0` |
| Catalogue role | extension |
| Release channel | Labs |
| Docs source | `packages/admin-help/docs` |
| Manifest | `capell.json` |

<!-- prettier-ignore-start -->

Anyone new to the admin gets stuck on some screen, and the quickest fix is a short answer where they are. Install Admin Help and a quiet blue note headed "Help for this screen" appears above the page content. It starts closed, and Show help opens it in place.

The note says what the screen is for and what to do next. It also answers a few questions editors really ask, such as how to add a page, why an invitation hasn't arrived or how to bring back something removed. At the bottom is a short list of plain words used across the admin, each with its meaning.

The note only shows on screens that have help written for them. Today that covers pages, the page editor, media, users, settings and most other screens that come with Capell. Other packages can add answers for their own screens, and a site without Admin Help looks exactly as it did before.

Editors read the answer, hide the note and carry on with the task in front of them.

- **Price and availability:** Check current availability and price on the [Capell Marketplace listing](https://capell.app/extensions/admin-help).
- **Licence:** Check the licence terms on the [Capell Marketplace listing](https://capell.app/extensions/admin-help).
- **Requires:** `PHP ^8.4`, `capell-app/admin ^1.0.78`, `capell-app/core ^1.0.75`, `filament/filament ^5.7.6`, `laravel/framework ^12.61.1|^13.12.0`, `livewire/livewire ^3.0|^4.0`, `lorisleiva/laravel-actions ^2.8`, `spatie/laravel-data ^4.5`, `spatie/laravel-package-tools ^1.15`.
- **Install:** `composer require capell-app/admin-help`.

## Quick Start

1. Install the package: `composer require capell-app/admin-help`.
2. Verify the package provider and manifest contributions are registered in the host app.

## For Developers

Screen help is keyed by admin route name in a keyed registry. A package registers a screen or extra answers through the registry class name, and the callback never runs when this package is absent, so no package needs a dependency on it.

## Configure

This extension works without configuration. There is nothing to set after install.

## Limits And Pitfalls

- Install the required Capell packages at the versions in `composer.json`: `capell-app/admin ^1.0.78`, `capell-app/core ^1.0.75`.

## Screens And Workflow

Docs gap: add `docs/screenshots.json` before promoting this package with visual workflow claims.

- Admin index screen if the package has a Filament resource.
- Create/edit screen if editors create records.
- Settings/configuration screen when settings exist.
- Frontend output when the package renders public pages.
- Package detail or install intent screen when marketplace-owned.

## Install Impact

- Required packages: `capell-app/admin`, `capell-app/core`.
- Admin navigation: no admin page or resource contribution is declared.
- Admin/editor extensions: none declared.
- Permissions: no package permission declarations or Shield gates detected; host access rules still apply.
- Public routes: none declared.
- Database changes: no package migrations declared.
- Config: no package config files.
- Settings: no package settings declared.
- Queues or schedules: none declared.
- Cache tags: none declared.
- Commands: none declared.

## Troubleshooting

| Symptom | Likely cause | Check | Fix |
| --- | --- | --- | --- |
| Package surface is missing after install | Provider or manifest is not loaded | Confirm `capell.json`, package `composer.json`, and provider registration | Reinstall the package, refresh Composer autoload, and clear host caches |

## Upgrading

No manual steps between minor versions.

Read [CHANGELOG.md](CHANGELOG.md) before upgrading.

## Next Steps

- [Package docs](README.md)
- [Overview](overview.md)
- [Troubleshooting](#troubleshooting)
- [Developer reference](reference.md)
- [Capell content language plan](../../docs/CONTENT_LANGUAGE_PLAN.md)
- [Capell documentation design system](../../docs/DESIGN_SYSTEM.md)
- [Capell and package ERD notes](../../docs/erd/capell-and-package-erds.md)

<!-- prettier-ignore-end -->