Add 'how it works' docs #321
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathonherbert
force-pushed
the
jsh/how-it-works-1
branch
from
0f155e6
to
212f85b
Compare
jonathonherbert
force-pushed
the
jsh/how-it-works-1
branch
from
77f98e0
to
ea80d43
Compare
davidfurey
approved these changes
Nov 21, 2023
docs/how-it-works.md
Outdated
| The `author__books` content expression, however, would be `"author__book*"` – as a repeater field, `author__books` can contain 0-many `author__book` nodes. | ||
|
|
||
| Finally, leaf nodes must represent user data in some way. There are two main ways of storing data in a ProseMirror Node: | ||
| - As node content. This is used whenever we want to express content types that are native to ProseMirror – for example, rich or plain text. The content expressions described above describe what sort of content a Node can contain. Data represented this way can be treated as part of the Prosemirror document – [`Selections`(https://prosemirror.net/docs/ref/#state.Selection)] and [`Decorations`](https://prosemirror.net/docs/ref/#view.Decoration), for example, will work as expected, and updates to this content can be incremental, which is important for collaborative editing. |
There was a problem hiding this comment.
Selections link isn't formatted correctly
jonathonherbert
commented
Nov 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
Adds a 'How it works' section, a table of contents (the readme is now quite large), and cleans up some redundant documentation.
'How it works' just details with some setup and the
NodeSpecgeneration for now. I've left placeholders for two parts that I think will be useful.How to test
Have a read. Useful? Comments?