Better documentation for collaboration

[vodkaslime]

Hi folks,

I raised an issue #2956, which was solved in terms of the error message. Then as a next step, I set up a simple local hocuspocus server following https://tiptap.dev/docs/hocuspocus/getting-started by https://platejs.org/docs/collaboration:

import { Hocuspocus } from "@hocuspocus/server";

// Configure the server …
const server = new Hocuspocus({
  port: 8000,
});

// … and run it!
server.listen();

After running the server, the frontend editor stays not rendered and uneditable.

So a naive question is: hey what should I do next to get a full-fledged collaborative editor running locally?

But a better question might be: are we planning on making a better documentation for https://platejs.org/docs/collaboration? If so, I would love to help. Tell me rough steps and I would be glad to contribute example code and docs along my way trying them out.

[vodkaslime]

Okay now I think I figured out the problem. The protocol should be ws rather than http. Now the editor is wired up. Love it. But still, the API section of the doc looks pretty random. Would be great if we have some actual example codes for each of them, to indicate their usage.

[ralphr123]

Hey! Did you end up finding any code examples for collaboration successfully implemented using Plate? Just starting on this now and I'm finding the lack of documentation to be a challenge.

[skynth]

Same feeling here, were either of you able to find a good example?