Documentation

How shipready reads my app

Five guides to read once, in order. Seven reference pages to open when something on the map doesn’t add up.

Guides

Five · read once, in order
1Start hereWhat this product does, in the order it does it.2Connect your first appWhat we ask GitHub for, and what happens to your code.3Reading your mapColumns, lines, letters and marks, and which of them move each other.4Getting your first test mergedFrom a dashed violet line to a solid one. Most of the time is spent waiting on GitHub.5When nothing turns greenThe pull request merged and the line is still dashed. What to look at, in order.

Reference

Seven · open when you need one
The mapYou’re looking at the board and want to know what a column means.Grades and checksA test merged and the letter on the box didn’t move.Every stateYou’re looking at a mark on the board and want the sentence for it.Every check we writeYou want to know what we’d write before you ask for it.What can and can’t be testedA line offered you nothing, and you want to know whether that’s a fault.The numbers at the topThe strip said 3 of 139 and you want to know 139 of what.What we never claimYou’re deciding how much weight to put on any of this.