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: Add Y-Sweet #1297

Merged
merged 4 commits into from
Dec 5, 2024
Merged

docs: Add Y-Sweet #1297

merged 4 commits into from
Dec 5, 2024

Conversation

jakelazaroff
Copy link
Contributor

@jakelazaroff jakelazaroff commented Dec 2, 2024

This PR adds Y-Sweet to…

Also fixes a typo on the Liveblocks and PartyKit examples 🙂

Also also heads up that I'm getting a bunch of docs: Module not found: Can't resolve '@blocknote/core' errors whenever I try to run npm run build:site!

Copy link

vercel bot commented Dec 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
blocknote ✅ Ready (Inspect) Visit Preview Dec 5, 2024 1:37pm
blocknote-website ✅ Ready (Inspect) Visit Preview Dec 5, 2024 1:37pm

Copy link

vercel bot commented Dec 2, 2024

@jakelazaroff is attempting to deploy a commit to the TypeCell Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Collaborator

@YousefED YousefED left a comment

Choose a reason for hiding this comment

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

Thanks! I removed the stuff in caps, a bit too much (for now).

Two questions:

  • While you link to a live demo, I'm missing example code or blocknote-specific documentation on how to set it up (even on the links you added). Are these WIP?
  • I understand your idea now is that you didn't add a live demo as it requires a collab server. Nevertheless, I think a live demo would be great, also because our examples are all expected to be live examples. Is it possible to (a) set up a dev server for this purpose, or (b) let the user enter a URL of their jamsocket / y-sweet instance? (strong preference for (a)

@jakelazaroff
Copy link
Contributor Author

@YousefED We set up a dev server! The example now points to demos.y-sweet.dev.

As to your question about the link, I switched the links to more closely mimic the Liveblocks and PartyKit ones (and removed the link to the live demo on our site, since it's embedded in the page now). Right now it points to the Y-Sweet getting started page, but we should have a tutorial and example repo specifically for getting started with BlockNote in the next day or so.

@jakelazaroff
Copy link
Contributor Author

Hi @YousefED, this should be fully ready now! The link in the Y-Sweet example now links to this tutorial https://docs.jamsocket.com/y-sweet/tutorials/blocknote

@YousefED YousefED changed the title Add Y-Sweet docs: Add Y-Sweet Dec 5, 2024
@YousefED YousefED merged commit 71792c2 into TypeCellOS:main Dec 5, 2024
2 of 3 checks passed
@jakelazaroff jakelazaroff deleted the y-sweet branch December 5, 2024 15:13
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.

2 participants