FAQ

Is it free?

Yes. No editions, no licence key, no licensing code.

Where are the notes stored?

In project config, as each layout element's ordinary tip — exactly where a tip you typed into the field layout designer goes. Xplain adds one more key, xplain.tips, holding a hash of each tip it wrote.

Will it overwrite tips I wrote?

No. Xplain only ever changes a tip whose text is exactly what it wrote last time.

Do content authors see them?

Not by default. They show to admins and to users with the See Xplain's developer tips permission. Turn on showToEveryone to show them to all.

Does it change the instructions authors see?

No. Field instructions are untouched. Xplain uses the tip, which is Craft's slot for a secondary note.

What happens on production?

Nothing, if allowAdminChanges is off: the tips arrive with project-config/apply, and Xplain does no writing of its own.

What if I uninstall it?

Its own tips are removed with it. Tips you wrote or edited stay.

Does it make outbound requests or add database tables?

Neither.