doc: various documentation formatting fixes

[ChALkeR]

Checklist

• documentation is changed or added
• commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

• Fix markdown code sample in releases.md, it was <a id="x.y.x></a>"
• Fix some markdown errors, e.g. in changelogs
• Fix broken defs links, e.g. in domain-postmortem.md
• Fix other broken refs, by @addaleax (addaleax@edb5c6a)
• Add links to some defs that were present but not linked to
• Remove dead defs
• Move defs to the bottom (one file affected)
• Add language indicators to all code blocks, using txt when no
  specific language could be chosen
• Some minor formatting changes (spaces, ident, headings)

[addaleax]

Wanna squash addaleax/node@edb5c6a in here? LGTM either way.

[ChALkeR]

@addaleax Squashed, thanks!

[ChALkeR]

/cc @nodejs/documentation

[ChALkeR]

@nodejs/collaborators, will land this tomorrow if no objections.

[silverwind]

does sh not work on these?

[ChALkeR]

It does highlight something, but not good.

Example:

$ cat script.js
function bad() {
  require('fs').readFile('/');
}
bad();

$ env NODE_DEBUG=fs node script.js
fs.js:88
        throw backtrace;
        ^
Error: EISDIR: illegal operation on a directory, read
    <stack trace.>

It's not a shell script, it's two shell commands + their output, and formatting the output as if it was a part of a shell script isn't a good idea imo.

[silverwind]

console might work:

$ cat script.js
function bad() {
  require('fs').readFile('/');
}
bad();

$ env NODE_DEBUG=fs node script.js
fs.js:88
        throw backtrace;
        ^
Error: EISDIR: illegal operation on a directory, read
    <stack trace.>

[ChALkeR]

Hm, nice. Will check if our doc tooling supports it and will file a pull request to fix that if it is.
Thanks!

[ChALkeR]

This is how our doc tooling renders it:

That doesn't look good enough to me.

[silverwind]

Hmm yeah, that sucks. Guess we should leave it at text until something better turns up :)

[silverwind]

LGTM with question

[ChALkeR]

Merged in a58b48b.

[evanlucas]

This isn't landing cleanly on v6.x. Mind backporting?

[ChALkeR]

@evanlucas, will do. Perhaps after #7727 lands.

[MylesBorins]

@ChALkeR setting don't land for v4.x let me know if you want to backport