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: Writing your own client guide. #1892

Merged
merged 5 commits into from
Nov 5, 2024
Merged

Conversation

thruflo
Copy link
Contributor

@thruflo thruflo commented Oct 25, 2024

See https://deploy-preview-1892--electric-next.netlify.app/docs/guides/writing-your-own-client

The URL format and headers have been updated to match the latest in #1900

Copy link

netlify bot commented Oct 25, 2024

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit f4e9636
🔍 Latest deploy log https://app.netlify.com/sites/electric-next/deploys/672a621dbe58800008e86cab
😎 Deploy Preview https://deploy-preview-1892--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 marked this pull request as ready for review October 28, 2024 13:20
@thruflo thruflo changed the title docs: wip on Writing your own client guide. docs: Writing your own client guide. Oct 31, 2024
Copy link
Contributor

@samwillis samwillis left a comment

Choose a reason for hiding this comment

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

This is really great!! I think it provides an even better overview of how sync works than the HTTP API docs page.

Python client is good, and provides such a simple overview of how to use the api. We could offer an asyncio version as that seems to be where Python has moved with all this stuff, and removes the need for the blocking sync() call and multiple processing. (If only gevent had been picked over asyncio...)

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.

Great stuff! This will be super helpful for all the engineers wanting to know how what's going on under the hood plus of course those wanting to build a new client in some other language.

website/docs/guides/writing-your-own-client.md Outdated Show resolved Hide resolved
@thruflo thruflo force-pushed the thruflo/writing-your-own-client branch from b127936 to f4e9636 Compare November 5, 2024 18:21
@thruflo thruflo requested a review from KyleAMathews November 5, 2024 18:23
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.

:shipit:

@thruflo thruflo merged commit 1c11132 into main Nov 5, 2024
4 checks passed
@thruflo thruflo deleted the thruflo/writing-your-own-client branch November 5, 2024 18:25
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