First draft for Transmit documentation

adonisjs / v6-docs

Documentation website for AdonisJS v6

38 stars 53 forks source link

First draft for Transmit documentation #78

Closed RomainLanz closed 2 months ago

RomainLanz commented 2 months ago

👋🏻

This PR adds the first draft of the Transmit documentation. The server and client documentation are currently on the same page. Let me know if you believe it makes sense to split them into two separate sections.

I have not explained how SSE works in the documentation; I believe we should also write an article and link it from the documentation for the people interested in more details.

I haven't documented events broadcasted by the Transmit instance. Do you believe it is a useful feature that needs documentation?

➡️ https://feat-transmit.v6-docs.pages.dev/guides/transmit

cloudflare-pages[bot] commented 2 months ago

Deploying v6-docs with Cloudflare Pages

Latest commit:	`430a1eb`
Status:	✅ Deploy successful!
Preview URL:	https://354cb7b2.v6-docs.pages.dev
Branch Preview URL:	https://feat-transmit.v6-docs.pages.dev

View logs

thetutlage commented 2 months ago

I would love to know a bit more about the deal with transports. Some questions on top of my mind are.

Why do I need transports?
If they are used for multi server communication, then how do you sync messages across servers?
Can one message be duplicated multiple times across servers?
Which redis data-structure is used? Or is it just pub/sub?

Messaging from background

This might be is already handled by transmit, but a very common use-case I usually have is broadcasting from a background process like a queue worker.

How will that work, since clients are not connected with the queue worker process.

RomainLanz commented 2 months ago

I have updated the documentation with your feedback.