Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shape documentation needs improving. #2316

Open
thruflo opened this issue Feb 10, 2025 · 1 comment
Open

Shape documentation needs improving. #2316

thruflo opened this issue Feb 10, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thruflo
Copy link
Contributor

thruflo commented Feb 10, 2025

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 thruflo self-assigned this Feb 10, 2025
@balegas balegas added the documentation Improvements or additions to documentation label Feb 17, 2025
@balegas balegas added this to the Next major release milestone Feb 17, 2025
@KyleAMathews
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants