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

docs: write patterns guide and example. #2021

Merged
merged 59 commits into from
Dec 9, 2024
Merged

docs: write patterns guide and example. #2021

merged 59 commits into from
Dec 9, 2024

Conversation

thruflo
Copy link
Contributor

@thruflo thruflo commented Nov 21, 2024

See https://deploy-preview-2021--electric-next.netlify.app/docs/guides/writes

(when following a GitHub link to the example you'll need to s/main/thruflo/writes-guide)

@thruflo thruflo changed the title docs: add a "Writes" guide documenting write patterns. docs: write patterns guide and example. Nov 22, 2024
Copy link
Contributor

Copy link

netlify bot commented Nov 22, 2024

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit 2a74c08
🔍 Latest deploy log https://app.netlify.com/sites/electric-next/deploys/6756e8d8e4a0750008460fc3
😎 Deploy Preview https://deploy-preview-2021--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@thruflo thruflo force-pushed the thruflo/writes-guide branch from 9492a98 to fd602b5 Compare December 2, 2024 08:17
@thruflo thruflo force-pushed the thruflo/writes-guide branch from 5b2201e to f47ef0e Compare December 3, 2024 21:28
@thruflo thruflo marked this pull request as ready for review December 3, 2024 22:10
Copy link
Contributor

@kevin-dp kevin-dp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had a look at the typescript client and the react hooks.
Changes look good to me!
Left some minor comments.

Regarding the CI failure i have no clue why it thinks that table is not a property of the shape stream options, it clearly is and it doesn't complain locally...

packages/typescript-client/src/match.ts Outdated Show resolved Hide resolved
packages/typescript-client/src/shape.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@KyleAMathews KyleAMathews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Lays out the options very neatly & a lot of people will get a lot of clarity here — there's a lot of confusion online about this stuff so it'll be very helpful for a lot of people to read these side by side.

packages/typescript-client/src/match.ts Outdated Show resolved Hide resolved
packages/typescript-client/src/types.ts Show resolved Hide resolved
website/docs/guides/writes.md Outdated Show resolved Hide resolved
website/docs/guides/writes.md Outdated Show resolved Hide resolved
@thruflo thruflo merged commit 9886b08 into main Dec 9, 2024
30 of 31 checks passed
@thruflo thruflo deleted the thruflo/writes-guide branch December 9, 2024 12:59
thruflo added a commit that referenced this pull request Dec 9, 2024
Add Writes guide and write-patterns example.
thruflo added a commit that referenced this pull request Dec 9, 2024
Add Writes guide and write-patterns example.
thruflo added a commit that referenced this pull request Dec 10, 2024
Add Writes guide and write-patterns example.
thruflo added a commit that referenced this pull request Dec 10, 2024
Add Writes guide and write-patterns example.
samwillis pushed a commit that referenced this pull request Dec 10, 2024
Add Writes guide and write-patterns example.
thruflo added a commit that referenced this pull request Dec 10, 2024
Add Writes guide and write-patterns example.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants