Would you be open to a major overhaul of the docs?

[mauricedoepke]

I am using this library for about 2.5 years in different production projects now and think it is in most cases the best way to access postgres from nodejs.

For that reason I find it sad to see, that it gets so little recognition in comparison to libraries like knex, typeorm or sequalize.

I suspect a major reason for this is the current state of the documentation. These other libraries have visually very pleasing documentations with lots of examples and simple to understand guided tours that make it easy for beginners to adopt them.

Pgtyped's documentation is very technical. People who are experienced and directly understand the value of this project will be able to utilize this.

But people who are less experienced or who got caught in the orm hype will likely be frustrated with the current state of the documentation.

As I plan to keep using this project for current and future projects I would like to see it strive.

For this reason I suggest doing a major overhaul of the docs with the goal to:

• make them more beginner friendly
• explain the advantages of pgtyped over orm's
• explain the advantages over other query builders
• give more practical use cases
• add faq's for common problems
• provide an opinionated tutorial

Would you be open to receive such changes to this project @adelsz ?

If yes I would love start this. I won't be able to provide a complete solution in two weeks. But I can invest a bit of time each week and see how fast it is going.

[adelsz]

Thanks @mauricedoepke. You are bringing up a valid point. I agree that the current documentation is quite spartan and technical and I am definitely open to any PRs improving that. There is a big chance that it will improve adoption.

My only suggestion is to work on it in manageable mergeable chunks, maybe splitting by pages/topics.

Also quite curious to learn more about your experience with pgTyped in production settings, if you are open to sharing more info please shoot me an email at <name>.<lastname>@gmail.com.

[gevera]

Totally agree with @mauricedoepke . As a biginner with pgtyped, I encounter simple errors like Client has already been connected. You cannot reuse a client. or I had to pass an empty params of type void just to run a query, even though there are no params in the query itself. SO yeah, its a bit of bumpy road for newcomers like me. I'd love to see more examples, from simple queries to more advanced ones. Maybe even examples of integrations with frameworks like Nest or Sveltekit