Very poor documentation

[ilyakaznacheev]

It would be great to add meaningful godoc comments and examples, document the ways the library can be used (how to use a different migration directory, how to register migrations from the code, etc.)

[shawn246]

I went through the md file and i didn't figure out how to do the migration. The example doesn't work at command "go run *.go" which i actually executed as "go run main.go". Poor documentation!

[RegisMelgaco]

I want to help with this issue! I think a have understand the basics and simpler idea of how to explain it.

[RegisMelgaco]

I was thinking about creating a example/tutorial like the existing one. Any suggestions where to write it and which topics to cover?

[vmihailenco]

@RegisMelgaco if you ask me I would add an article to https://github.com/go-pg/docs/tree/master/docs. It will be published on https://pg.uptrace.dev/

But godoc comments or an example in this repo will be helpful too I guess :)

[RegisMelgaco]

Thanks for the tips! So I will prioritize writing the article, since it would be incorporated in the docs.

[NivardoX]

Any updates on that? I can also help.