NAME
Database::BI::Tutorial - the chapters of the in-application tutorial
DESCRIPTION
The tutorial that the application shows at GET /tutorial is built from the data in this module. A chapter is one feature: a title, a short lead, numbered steps, and the routes that it covers. The template renders the chapters in order, so adding a feature means adding a hash here, not editing HTML.
A chapter may also have a walkthrough: a worked example with a title, an intro, a list of steps that each say what to do and what to see, and a result. The template shows it as one box, and the contents marks the chapter so a reader can find it.
t/tutorial.t checks that every GET page in Database::BI is either covered by a chapter or listed in exempt_routes() with a reason. Keep the sentences short: the same test fails a lead, step, tip or walk-through sentence longer than 25 words.
chapter_for_action() maps a controller action to the chapter that helps with that page. The application calls it from a before_render hook and the shared layout shows the result as a Help: ... link beside the main Tutorial link. A new page action belongs in %ACTION_CHAPTERS; the test fails until it is there.
AUTHOR
Nigel Horne <njh@nigelhorne.com>
LICENCE AND COPYRIGHT
Copyright 2026 Nigel Horne.
Usage is subject to the GPL2 licence terms.