This PR combines a few minor changes to the docs that I noticed while working on #5318
Add missing top-level headers to two files
Standardise on fenced code blocks in markdown, for consistency and to allow language declarations
Use language declarations for yaml code blocks
I also considered adding language information for code intended to be typed at the console, but then that turns out to be more complex with a choice of declarations (e.g. bash vs console) and whether to add $ as a guide that it should be typed, and what to do with things that start with a console command but is then mainly irb from that point on, so I'll leave all that for some other time.
tomhughes
commented
1 week ago
This PR combines a few minor changes to the docs that I noticed while working on #5318
I also considered adding language information for code intended to be typed at the console, but then that turns out to be more complex with a choice of declarations (e.g.
bashvsconsole) and whether to add$as a guide that it should be typed, and what to do with things that start with a console command but is then mainlyirbfrom that point on, so I'll leave all that for some other time.