Improve documentation should be in the roadmap

[angelcervera]

First time trying to use this library to generate pdfs in Go and is really difficult to figure out how to use it. I understand that it's a beta, but in my opinion, improving documentation should be in the roadmap as well.

If the idea is to have something like Bootstrap, maybe a good start will be explain how is working the grid system in this library. For example, size and height parameters are everywhere, but what is exactly size and height? Are pixels, number of columns in a grid? etc...

Also, why don't write comments at least in the samples? If that is for people that does know how it is working, why don't help a little bit more?

[johnfercher]

Hello, @angelcervera. You are correct, we have to improve the documentation. The V1 was completely documented, but as V2 has changed a lot we have a huge work ahead to reach the level of detail in V1.

We had two releases focused in documentation recently:

• https://github.com/johnfercher/maroto/releases/tag/v2.0.0-beta.10
• https://github.com/johnfercher/maroto/releases/tag/v2.0.0-beta.8

I'm also trying to connect the maroto.io and GoDoc to improve understanding:

• https://maroto.io/#/v2/features/addpage?id=add-page

Another thing that is missing is the examples:

• https://pkg.go.dev/github.com/johnfercher/maroto/pkg/pdf#example-PdfMaroto.Signature

Improve documentation is in our roadmap, but it will take a huge effort. I will make some changed in maroto.io and README.md to let clear that improve documentation is in our roadmap.

[johnfercher]

V2 documention is spread between these 3 links:

• https://pkg.go.dev/github.com/johnfercher/maroto/v2 (only the entrypoint of maroto)
• https://pkg.go.dev/github.com/johnfercher/maroto/v2/pkg (all the other parts)
• https://maroto.io/#/v2/features/addpage?id=add-page (section features in maroto.io)