Version: 0.21.0This documentation is for Spitfire 0.21.0.
Welcome
This documentation ships inside Spitfire: an installation without internet access shows the same pages. Each page covers one job: what it is for, when to use it, and how to do it step by step.
What it is for
From writing a test to connecting a runner and comparing runs, you find here how every screen of Spitfire is used. The pages are grouped into sections on the left; the headings of the page you are reading are on the right.
Finding what you need
- Click Search the docs on the left, or press Ctrl+K (⌘K on macOS).
- Type what you are looking for, for example
threshold,runnerorCSV. Accents do not matter:semaalso finds "şema". - Move through the results with ↑ and ↓ and open one with Enter. A result takes you straight to its heading.
The search covers page titles, headings and the full text. With several words, you get the sections that contain all of them.
The "?" button on every screen
Every page of the app has a ? button on the right of its title. It opens the documentation page for that screen on the right-hand side, scrolled to the relevant part. To keep reading, use Open full page at the top.
The ? button in a page header and the help drawer it opens
How the pages are laid out
Every page follows the same order:
| Part | What it holds |
|---|---|
| What it is for | The purpose of the screen or feature |
| When to use it | The situations it is for |
| Step by step | Numbered steps and screenshots |
| Common problems | Symptom → cause → fix |
| Related pages | What to read next |
The TR / EN buttons at the top right change the UI language, and the documentation follows. A page not yet written in that language is shown in the other one.
Printing
Print a page (or save it as a PDF) with the browser's print command (Ctrl+P / ⌘P): the menus are hidden and only the page itself is printed.
Related pages
- Go to the dashboard
In Spitfire: /dashboard - Tests
In Spitfire: /tests