PHPackages                             laravel-afterburner/playbook - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. laravel-afterburner/playbook

ActiveLibrary[Utility & Helpers](/categories/utility)

laravel-afterburner/playbook
============================

In-app playbook documentation for Afterburner applications

1.5.6(1mo ago)09↓88.9%MITPHPPHP ^8.2

Since May 29Pushed 1mo agoCompare

[ Source](https://github.com/laravel-afterburner/playbook)[ Packagist](https://packagist.org/packages/laravel-afterburner/playbook)[ RSS](/packages/laravel-afterburner-playbook/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependencies (14)Versions (16)Used By (0)

Afterburner Playbook
====================

[](#afterburner-playbook)

In-app documentation for Afterburner applications. The playbook ships platform guides and aggregates documentation from optional packages through a registry — similar to how navigation items are registered.

Installation
------------

[](#installation)

```
composer require laravel-afterburner/playbook
php artisan afterburner:playbook:install
```

Add the path repository when developing locally:

```
"repositories": {
    "afterburner-playbook": {
        "type": "path",
        "url": "../afterburner-playbook"
    }
}
```

Usage
-----

[](#usage)

Visit `/help` when signed in. A **Help & Support** link is registered via `TeamNavigation` (default placement `system-support` in strata apps, or `default` / order 20 in other hosts).

### FAQ

[](#faq)

Visit `/help/faq` for frequently asked questions. FAQ access is separate from playbook documentation:

Permission slugPurpose`view_playbook`Read in-app help documentation`view_playbook_faqs`View published FAQs`manage_playbook_faqs`Create, edit, reorder, publish, and delete FAQs (implies view)In Strata, assign these under **Help** in Role Manager. `manage_playbook_faqs` bundles `view_playbook_faqs`. Users can hold FAQ permissions without `view_playbook`.

When team RBAC is unavailable (standalone package tests), published FAQs remain visible to authenticated users. System administrators always have full FAQ access.

After installing or upgrading, run migrations so the `playbook_faqs` table exists:

```
php artisan migrate
```

Registering a section from a package
------------------------------------

[](#registering-a-section-from-a-package)

```
use Afterburner\Playbook\Support\Playbook;

// In your ServiceProvider::boot()
if (class_exists(Playbook::class)) {
    Playbook::register([
        'key' => 'meetings',
        'label' => 'Meetings',
        'order' => 20,
        'path' => __DIR__.'/../../playbook',
        'enabled' => fn () => config('afterburner-meetings.enabled', true),
        'permission' => fn ($user) => $user?->can('viewAny', Meeting::class) ?? false,
    ]);
}

// Entity menu link (order > Subscriptions' 15, default placement):
TeamNavigation::register([
    'label' => 'Help & Support',
    'route' => 'playbook.index',
    'order' => 20,
    ...
]);
```

Ship markdown files under `playbook/` in your package:

```
playbook/
  scheduling-an-agm.md
  meeting-notices.md

```

### Page front matter

[](#page-front-matter)

```
---
title: Scheduling an AGM
slug: scheduling-an-agm
order: 10
group: scheduling
group_order: 100
---

## Before you begin
...
```

Supported front matter keys:

KeyDescription`title`Page title (required)`slug`URL slug (defaults to filename)`order`Sort order within group`group`Sidebar group label (defaults to folder name)`group_order`Sort order for sidebar groups (defaults to `0` for `getting-started/` folders, otherwise `100`)`feature`Hide unless `App\Support\Features` flag is enabled (typically used for optional platform security pages)`system_admin`Restrict to system administrators (`true` by default for pages under a `system-admin/` folder)### Placeholders

[](#placeholders)

Use these in markdown body copy:

- `{{ entity_label }}` — e.g. `strata`, `team`
- `{{ entity_label_title }}` — e.g. `Strata`
- `{{ entity_label_plural }}` — e.g. `stratas`, `teams`
- `{{ app_name }}` — configured application name

### Internal links

[](#internal-links)

```
See [Entity overview](/help/platform/entity-overview).
```

Validate links:

```
php artisan playbook:validate
```

Configuration
-------------

[](#configuration)

Publish config with `php artisan vendor:publish --tag=afterburner-playbook-config`.

If you previously published views (`afterburner-playbook-assets`), republish or delete `resources/views/vendor/afterburner-playbook` so UI updates apply — published views override the package.

VariableDefaultDescription`AFTERBURNER_PLAYBOOK_ENABLED``true`Master switch`AFTERBURNER_PLAYBOOK_NAVIGATION_ENABLED``true`Show link in entity menu`AFTERBURNER_PLAYBOOK_DEFAULT_SECTION``platform`Landing section`AFTERBURNER_PLAYBOOK_DEFAULT_PAGE``welcome`Landing page slugTesting
-------

[](#testing)

```
composer test
```

License
-------

[](#license)

MIT

###  Health Score

40

—

FairBetter than 86% of packages

Maintenance90

Actively maintained with recent releases

Popularity4

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

15

Last Release

48d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c89a4bde39061db2498ed98e084ccab43ec033d496994ade8a8beed1b0bd0450?d=identicon)[FoxRocks76](/maintainers/FoxRocks76)

###  Code Quality

TestsPHPUnit

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/laravel-afterburner-playbook/health.svg)

```
[![Health](https://phpackages.com/badges/laravel-afterburner-playbook/health.svg)](https://phpackages.com/packages/laravel-afterburner-playbook)
```

###  Alternatives

[team-nifty-gmbh/tall-datatables

Server-side rendered datatables for Laravel and Livewire

1320.9k4](/packages/team-nifty-gmbh-tall-datatables)[tomshaw/electricgrid

A feature-rich Livewire package designed for projects that require dynamic, interactive data tables.

119.4k](/packages/tomshaw-electricgrid)[noerd/noerd

101.4k10](/packages/noerd-noerd)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)