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: Added conceptual view of the Lexical Core Design #5677

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

StyleT
Copy link
Contributor

@StyleT StyleT commented Mar 2, 2024

This allows the viewer to have a simple visual representation of what Lexical Core actually does and how User Application shall interact with it.

Any suggestions are welcomed!

Copy link

vercel bot commented Mar 2, 2024

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

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 5, 2024 1:03am
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 5, 2024 1:03am

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Mar 2, 2024
acywatson
acywatson previously approved these changes Mar 2, 2024
Copy link
Contributor

@acywatson acywatson left a comment

Choose a reason for hiding this comment

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

I think this works, but will give others a chance to review.

It doesn't really cover the asynchronous nature of state updates (i.e., batching), but I'm not sure that's strictly necessary. Another gap would be update listeners, which are also triggered at the end of the update cycle.

There are a few charts in here that may be helpful, though I think your approach works better for written documentation.

@StyleT
Copy link
Contributor Author

StyleT commented Mar 3, 2024

I think this works, but will give others a chance to review.

It doesn't really cover the asynchronous nature of state updates (i.e., batching), but I'm not sure that's strictly necessary. Another gap would be update listeners, which are also triggered at the end of the update cycle.

There are a few charts in here that may be helpful, though I think your approach works better for written documentation.

Thanks for the feedback! I’ll add listeners for sure!
Talking about the lack of async nature of the state update demonstration - it’s intentional to keep this diagram small and easy. More will follow on state lifecycle as I dig deeper into architecture here.

ivailop7
ivailop7 previously approved these changes Mar 3, 2024
@acywatson
Copy link
Contributor

I think this works, but will give others a chance to review.
It doesn't really cover the asynchronous nature of state updates (i.e., batching), but I'm not sure that's strictly necessary. Another gap would be update listeners, which are also triggered at the end of the update cycle.
There are a few charts in here that may be helpful, though I think your approach works better for written documentation.

Thanks for the feedback! I’ll add listeners for sure! Talking about the lack of async nature of the state update demonstration - it’s intentional to keep this diagram small and easy. More will follow on state lifecycle as I dig deeper into architecture here.

I just realized I forgot to add the link:

https://docs.google.com/presentation/d/1IanPm9qzLP4Oiqht83weMCZalCaCJpH4QvFqeD29-uQ/edit#slide=id.p

I meant to say "there are a few charts in here (above link) that may be helpful".

@StyleT
Copy link
Contributor Author

StyleT commented Mar 5, 2024

@acywatson @ivailop7 PTAL and merge, updated diagram a bit.

I'll use info from https://docs.google.com/presentation/d/1IanPm9qzLP4Oiqht83weMCZalCaCJpH4QvFqeD29-uQ/edit#slide=id.p within other pages as within conceptual view we're treating lexical core as black box, while those examples showcase inner design.

@acywatson acywatson merged commit 354d147 into facebook:main Mar 5, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants