Skip to content

Commit

Permalink
(WIP) Add migration guide for v2
Browse files Browse the repository at this point in the history
Based on e71ed5f...c64732c.

Note that 1.2.50, to which this guide refers, doesn't exist yet. We’ll
do that in #1672.

The description of the stats response changes comes from Simon in [1].

HTML tags used for headings so that I can specify a fixed `id` to use in
fragment links, because I’m probably going to keep editing the headings
and so if I rely on the generated headings then I’ll almost certainly
end up with a broken link. (GitHub doesn’t seem to support the custom
heading ID syntax described in [2].) And we don’t have a linter that
checks for broken fragment links.

Resolves ECO-1416.

(TODO remove) Skipping CI whilst editing this, to avoid loads of
pointless test runs; will undo once editing done:

[skip ci]

[1] #1670 (comment)
[2] https://www.markdownguide.org/extended-syntax/#heading-ids
  • Loading branch information
lawrence-forooghian committed Mar 20, 2024
1 parent fcef1a5 commit a75e9c8
Showing 1 changed file with 395 additions and 0 deletions.
Loading

0 comments on commit a75e9c8

Please sign in to comment.