effect
effect copied to clipboard
Effect-TS
sql-drizzle is completely undocumented
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,
And no docstrings in the JSDoc:
Where did you find it?
No response
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.
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.
Hi @tmcw, I’ve read this issue #3695 pointing me here. It would be great if we could start working on improving the documentation of the JSDocs.
Let me know if needs help! I'm trying to learn it so would be a perfect thing to do! Also not only for me but for everyone else!
