Improve the documentation

[antoinetavant]

First of all, thanks for your tool ! It works like a charme ! I hope I did not miss the documenation and that my issue is meaninfull.

Feature request

As a new user of just one day, I am looking for a more didactic documentation, with User guide, how-tos, etc.

The installation and the few examples of the Readme are great, but more can be added for new users (like myself)

Possible solutions

A documentation website hosted on ReadTheDocs or as a github page, including

• details of the CLI parameters (API reference)
• how-tos
• Illustrations
• Realeses
• explainations of the examples already provided

Alternative solutions

The Gitlab wiki is a possible, as well as just providing markdow files in the project repository. It is simpler to manage, but less nice.

additional context

I'm willing to contribute to this Issue, But I never developed a documentation for TS projects. However, I'm used to document python projects with Sphinx.

[firecow]

You are more than welcome, to give whatever tool or way you find suited a shot 👍 It will be merged, no doubt about it.

[hverlin]

https://vitepress.dev/ and https://rspress.dev/ are good options