-
Notifications
You must be signed in to change notification settings - Fork 72
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
Editor enhancements docs #2222
Editor enhancements docs #2222
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Double-check what's going on with the ## Basics sections as they are not getting rendered right now. Other than that, you're mostly good to go.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- The ProseMirror articles must be linked from the Editor Overview page.
- We should add disclaimers that we don't provide support for creating ProseMirror schemas and plugins.
-
The ProseMirror schema articles contain a lot of repeating content. Consider merging all three articles into one. The resulting page may look long, but that's mainly because of the large examples. The readable content is not that much. -
The previous point will allow the remaining two ProseMirror articles to reside in a single ProseMirror folder. - The documentation build scripts assume that all page titles start with the component Name. "Blazor" is prepended automatically. This leads to titles like "Blazor ProseMirror Schema Overview" or "Blazor Modify the ProseMirror schema". So, try rewording and include the component name in the title for SEO purposes. For example, "Editor Schema Customization".
Nadya's update: In an offline discussion, we agreed to keep the current structure and I've crossed out the corresponding items in the ist.
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
* docs(editor): plugin and schema docs * docs(editor): add schema docs * docs(editor): updates * docs(editor): create new schema docs and sampple * docs(editor): update articles * Update _contentTemplates/editor/general.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update _contentTemplates/editor/general.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update _contentTemplates/editor/general.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update _contentTemplates/editor/general.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update _contentTemplates/editor/general.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-plugins.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-plugins.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-plugins.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-plugins.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update _contentTemplates/editor/general.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update _contentTemplates/editor/general.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update components/editor/prosemirror-plugins.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update components/editor/prosemirror-plugins.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update components/editor/prosemirror-schema/create-new-schema.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update components/editor/prosemirror-schema/create-new-schema.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update components/editor/prosemirror-schema/create-new-schema.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update components/editor/prosemirror-schema/create-new-schema.md Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> * Update components/editor/prosemirror-schema/overview.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-plugins.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update _contentTemplates/editor/general.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/overview.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/overview.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/overview.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/modify-default-schema.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/modify-default-schema.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/modify-default-schema.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/modify-default-schema.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * Update components/editor/prosemirror-schema/create-new-schema.md Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com> * docs(editor): address feedback * chore(editor): update samples and links * chore(editor): address feedback * chore(editor): update structure and remove repeating info * chore(editor): minor fixes * chore(editor): update exteral links --------- Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com> Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
Related to https://github.com/telerik/blazor/issues/9377 and https://github.com/telerik/blazor/issues/9371