electric icon indicating copy to clipboard operation
electric copied to clipboard

Shape documentation needs improving.

Open thruflo opened this issue 10 months ago • 1 comments

Our shapes guide is currently (increasingly) full of technical details about where clause evaluation etc.

What it doesn’t do is a good job of explaining how to use shapes to achieve what you want to achieve.

It needs to be updated to move technical details off the core explanatory path and to show how shapes can be used to achieve usage patterns.

thruflo avatar Feb 10 '25 10:02 thruflo

Note form Discord — "my two cents: I think the shape ~ sql query analogy is pretty good/easy to grasp, and might be worth putting in documentation? if it’s already there I missed it but it definitely would have made me more excited about using Electric/made some design decisions (like this one) easier"

https://discord.com/channels/933657521581858818/933657523049885698/1346227238424547449

KyleAMathews avatar Mar 03 '25 21:03 KyleAMathews