guide
Documentation
The package in detail: installation, concepts, reference and migration.
- Getting started
Install the two packages, run a first tour, and wire the provider to a real application.
- Tours
The shape of a tour and its steps, the missing target policy, multi page tours, interactive steps, advancing on a click and manual control.
- Checklist
A list of first steps, what actually completes an item, its link with tours, and the two components that render it.
- Hotspots
A marker on one element that opens a short explanation and can start a tour, what retires it for good, and when it draws nothing at all.
- Persistence
How guide stores tour, checklist and hotspot progress, what the GuideStorage contract requires, and what happens when a read is slow.
- Accessibility
What guide does for a keyboard user and a screen reader, and the deliberate exceptions.
- API reference
Every exported symbol of guide-core and guide-mui, with its signature and what it does.
- Migrating to 0.2.0
What changes for an application on 0.1.x, in order, and what needs no attention at all.
- Migrating to 0.3.0
What changes for an application on guide-core 0.2.0 and guide-mui 0.3.0, in order, and the one thing that needs attention.