Known shortcomings with diff-documents

[chrisfenner]

Open

• Strange numbering for deleted section headings

• Completely deleted tables lose their tabular formatting

• Changes only within tables sometimes don't mark the page as changed
• Table cells with newlines sometimes have their newlines removed

Resolved

• Mermaid diagrams are always counted as changed because the temp filename changes

• Deleting a whole row from a table is a bit ugly (but adding one is fine)

• Edited equations don't get highlighted

• Warning spew in latex when there are changes to equations

LaTeX Warning: Command \pdfstringdef invalid in math mode on input line 2323.

• Code diffs indent a little weird

• Diffing algorithm inserts a few empty diffs in certain places

• Diff sometimes takes a LONG time. Consider splitting out diff generation job so that the main doc gets uploaded sooner?

Example: Part1 took 15 minutes in https://github.com/TrustedComputingGroup/TPM-Spec/actions/runs/10816111225

[chrisfenner]

Mermaid issue was resolved in #178