TODO list to improve documentation

[Remi-Gau]

high level issues

For example, pages that should be merged or sections that should be extracted to become a page....

• extract Tips and tricks into its own page, maybe move some of it into the FAQ
• actually add definitions to the glossary (not needed anymore)
• add sections to the FAQ
• replace "what-did-we-add" sections of the tutorial with highlighting: https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#highlighting-specific-lines - done in [REF] refactor documentation  #487
• create jsonld files that hold the content that is displayed in the doc to make it possible to validate their content - done in [REF] refactor documentation  #487

low level issues

• fixed in [FIX] misc minor fixes to the documentation #482

For example formatting, file names and structure...

• about_this_doc should become a CONTRIBUTING.md
• remove numbers prefix in filenames
• ensure that all code blocks have syntax highlighting
• ensure proper formatting of markdown
  for example to avoid things like at the bottom of this page

[yibeichan]

We should probably work on README.md files for all reproschema-related repos and make sure they can link to each other.

[Remi-Gau]

I am going to close this issue because most items are done AFAICT.

For the remaining points we can just open new issues.