The Overview

This page covers the Overview, Ghostwriter's own home in the panel, and the widget for the panel's Dashboard.

The Overview#

Ghostwriter → Overview. Once Get started is done, the Ghostwriter item opens here.

At the top#

• Get started, while it's shown: "N of M steps done.", the next step, Continue (which opens Get started on that step) and Hide (for people who manage Ghostwriter). See Get started.
• If the writing provider's key isn't set, a one-line warning, No API key yet, says which variable to add to .env.
• Suggest kinds everywhere, at the top right, looks for kinds in every resource at once, one model call per resource. It's shown when there is more than one resource. Opening the Overview never looks for kinds by itself; only Get started does.

The tiles#

Five tiles:

• In progress: pieces not yet saved as a record. With shared conversations on, that's everyone's ("Pieces not yet saved"); with them off, only yours ("Your pieces not yet saved").
• Content plan: open ideas waiting, linking to the plan.
• Voice guide: Written or Not written yet, and when it was updated, linking to the guide.
• Image style: Written or Not written yet, and when it was updated, linking to the image style.
• Kinds of content: how many are learned, across how many resources.

Carry on#

The newest pieces in progress, everyone's when conversations are shared. Each shows its resource, "Editing" for an existing record, and, when shared, "Started by …, last changed by …".

• Click one to reopen it where it was left: on the Create page for a new record, or the Edit page for one being edited.
• Remove deletes a piece and its conversation, after asking. It's shown on pieces you started, and on everyone's if you manage Ghostwriter (see Deleting a piece).

A piece leaves the list once its record is saved.

Each resource#

A section for each resource Ghostwriter writes for, showing:

• how many published records it has to learn from, how many kinds are learned, and how many of the form's fields Ghostwriter can write ("12 to learn from · 1 kind · 5 of 8 fields to write")
• the kinds learned, as badges. Click one to edit it.
• suggested kinds to review ("2 suggested kinds to review"), with Learn this, Learn all N and Not this
• warnings when the form has changed since it was read, or has fields that couldn't be read (see How forms are read)

And three buttons:

• Teach a kind (Teaching a kind yourself)
• Suggest kinds, which looks at this resource (one model call)
• Write, which opens the Create page with Ghostwriter open

The page checks back by itself while kinds are being suggested or learned.

At the foot, Show Get started brings back a hidden Get started, for people who manage Ghostwriter.

The Overview follows the panel's dark mode.

The dashboard widget#

Ghostwriter has a widget for the panel's own Dashboard. Turn it on where the plugin is registered:

GhostwriterPlugin::make()
    ->resources([...])
    ->widget()

It shows:

• "Get started: N of M done", until every required step is done
• how many pieces are in progress, and how many ideas are waiting on the plan
• the newest pieces, to carry on. With shared conversations on, that's everyone's, with the name of whoever started each one.
• Write something: a menu of the resources to write for. With one resource it is a single button, such as Write Posts.
• Open, which goes to the Overview

With nothing in progress it says "Nothing in progress."

Without an API key it says "Ghostwriter has no API key yet." Its links still work, and Write something is shown but switched off until a key is added.

It's shown to people allowed to use Ghostwriter. Like Filament's other dashboard widgets, it loads once it scrolls into view.