search

Effect-TS / effect

An ecosystem of tools to build robust applications in TypeScript
https://effect.website
MIT License
7.69k stars 244 forks source link

sql-drizzle is completely undocumented #3796

Open tmcw opened 1 month ago

tmcw commented 1 month ago

What is the type of issue?

Documentation is missing

What is the issue?

Effect apparently has a drizzle integration, but it's completely undocumented, no docs on the website,

CleanShot 2024-10-17 at 11 05 18@2x

And no docstrings in the JSDoc:

CleanShot 2024-10-17 at 11 12 00@2x

Where did you find it?

No response

tmcw commented 1 month ago

This goes for most of the effect addons, afaict - a few are lucky enough to have README.md files, but most don't have any JSDoc descriptions, no examples, no documentation on the website. I think that, more than any other factor, the lack of documentation is the blocker for onboarding my team onto Effect, between the missing JSDoc in the core module #3695 and extensions, there just seems to be a lot of energy toward adding features to the Effect ecosystem and no energy for documenting them.

jessekelly881 commented 1 month ago

For the moment there's: https://github.com/Effect-TS/effect/blob/main/packages/sql-drizzle/examples/sqlite.ts or https://github.com/Effect-TS/effect/tree/main/packages/sql-drizzle/test

Most of the effect "addon" packages are in a state of heavy changes (pre-v1.0.0) so there isn't much point in documenting them until the api stabilizes. I would just recommend reading through tests and examples for the time being and waiting to use anything pre-1.0.0 if api stability is important. There has been a lot of effort made towards documenting the more stable packages though.