How about a task force to generate a better documentation?

I will just leave this here: About | Divio Documentation It is an amazing guide how to write great documentation for software. In essence a documentation system needs four different resources to facilitate learning at different levels:

  • Tutorials (learning oriented)
  • How to guides (problem oriented)
  • Explanation (understanding oriented)
  • Reference (information oriented)

In my opinion Typst has a very good references.

There are some great explanations in Laurenz’s Blog but there should be more resources like that. It would be nice if experienced Typst developers would publish e.g. how they go about and patch issues, how does the query engine work, etc…

The tutorial in the docs is ok but it is only one example. It would be nice if there were a few more tutorials how to create some standard categories of documents: CV, booklet, datasheet, invitation with some fancy graphics, project report.

The how to guides are essentially missing. This is the FAQ that we need. How do I put an image in a page corner? How do I use a custom font? How do I center an image? Essentially everything that is asked for in the Discord all the time.

When you create resources like that please also remember to state the version of Typst you use. It is all too common to find old tutorials that don’t work in the current version.

4 Likes