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

1. On any screen, click the ? in the top bar (left of the theme button) or press Ctrl+K (⌘K on macOS). Here, Search the docs on the left opens the same search.
2. Type what you are looking for, for example threshold, runner or CSV. Accents do not matter: sema also finds "şema".
3. Move through the results with ↑ and ↓ and open one with Enter. A result takes you straight to its heading.

#Asking the assistant

Every screen has a round Assistant button in the bottom right corner. Tell it in your own words what you want to do: "how do I set up a monitor", "import a postman collection", "how to define a threshold".

1. The assistant finds the screen that does the job: Go to the screen takes you there and Open the docs opens the heading that explains it. If the screen is for admins only, it says so.
2. Below that, it lists the sections it found in the docs.
3. If you made a typo, Did you mean offers the corrected question. It also understands Turkish suffixes: "monitörü" finds the same as "monitör".

Opened without a question, it shows short tips and one-click questions for the screen you are on. If something on the installation needs attention, it says that first: a monitor that is alerting, no runner online, or no runs in the last 7 days.

Privacy: The assistant runs entirely in your browser, over this installation's docs. Your questions are not sent or stored anywhere, and it does not connect to an AI service.

#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:

#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