Skip to content

Docs: Standardize and clean up table formatting

Problem to solve

We format Markdown tables in a wide variety of ways. While they usually render correctly, this inconsistency makes them hard to maintain, but also makes it hard for the localization team to translate them. We should:

  • Improve our docs about table formatting.
  • Use auto-formatting as much as possible.
  • Avoid edge case formatting like extremely short delimiter (second) rows: |-|-|-|
  • Keep Descriptions columns on the far right, when possible.
  • Make sure inputs are always backticked so they aren't translated.

Other links/references

Edited by Marcel Amirault