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.

Sign up for GitHub

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

Jump to bottom

Editor enhancements docs #2222

Merged
merged 39 commits into from
Jul 25, 2024
Merged

Editor enhancements docs #2222

merged 39 commits into from
Jul 25, 2024

Conversation

ntacheva
Copy link
Contributor

@ntacheva ntacheva commented Jul 9, 2024

@ntacheva ntacheva requested a review from a team July 18, 2024 15:12
@ntacheva ntacheva changed the title [WIP] Editor enhancements docs Editor enhancements docs Jul 18, 2024
@ntacheva ntacheva marked this pull request as ready for review July 18, 2024 15:13
@ntacheva ntacheva requested a review from a team as a code owner July 18, 2024 15:13
ikoevska
ikoevska approved these changes Jul 19, 2024
View reviewed changes
Copy link
Contributor

@ikoevska ikoevska left a 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.

_contentTemplates/editor/general.md Outdated Show resolved Hide resolved
_contentTemplates/editor/general.md Outdated Show resolved Hide resolved
_contentTemplates/editor/general.md Outdated Show resolved Hide resolved
_contentTemplates/editor/general.md Outdated Show resolved Hide resolved
_contentTemplates/editor/general.md Outdated Show resolved Hide resolved
components/editor/prosemirror-plugins.md Outdated Show resolved Hide resolved
components/editor/prosemirror-plugins.md Outdated Show resolved Hide resolved
components/editor/prosemirror-plugins.md Outdated Show resolved Hide resolved
components/editor/prosemirror-plugins.md Outdated Show resolved Hide resolved
components/editor/prosemirror-plugins.md Show resolved Hide resolved
dimodi
dimodi reviewed Jul 19, 2024
View reviewed changes
Copy link
Contributor

@dimodi dimodi left a comment •
edited by ntacheva
Loading

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.

ntacheva and others added 26 commits July 22, 2024 18:14
@ntacheva @ikoevska
Update components/editor/prosemirror-plugins.md
61ea79a 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @dimodi
Update _contentTemplates/editor/general.md
f8ac3ee 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @dimodi
Update _contentTemplates/editor/general.md
5a06fde 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @dimodi
Update components/editor/prosemirror-plugins.md
07eacbb 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @dimodi
Update components/editor/prosemirror-plugins.md
f9ca941 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @dimodi
Update components/editor/prosemirror-schema/create-new-schema.md
714f111 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @dimodi
Update components/editor/prosemirror-schema/create-new-schema.md
8965755 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @dimodi
Update components/editor/prosemirror-schema/create-new-schema.md
bfd8d6f 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @dimodi
Update components/editor/prosemirror-schema/create-new-schema.md
cf2baa1 
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/overview.md
14823d8 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-plugins.md
43e1663 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update _contentTemplates/editor/general.md
466c3ca 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/overview.md
37aebeb 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/overview.md
46888c2 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/overview.md
68d2e40 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/modify-default-schema.md
5899ae3 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/modify-default-schema.md
d934c85 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/modify-default-schema.md
0935ea3 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/modify-default-schema.md
7b7b5e5 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva @ikoevska
Update components/editor/prosemirror-schema/create-new-schema.md
a589df9 
Co-authored-by: Iva Stefanova Koevska-Atanasova <koevska@progress.com>
@ntacheva
docs(editor): address feedback
cad50db
@ntacheva
chore(editor): update samples and links
bd1f561
@ntacheva
chore(editor): address feedback
8a3fff3
@ntacheva
chore(editor): update structure and remove repeating info
6fd3e3d
@ntacheva
chore(editor): minor fixes
351a257
@ntacheva
chore(editor): update exteral links
e8b77ef
@ntacheva ntacheva merged commit 9830b82 into master Jul 25, 2024
1 check passed
@github-actions github-actions bot deleted the editor-enhancements-docs branch July 25, 2024 12:41
NansiYancheva pushed a commit that referenced this pull request Aug 1, 2024
@ntacheva @dimodi
@ikoevska @NansiYancheva
Editor enhancements docs (#2222)
d8d6188 
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dimodi dimodi dimodi approved these changes

@ikoevska ikoevska ikoevska approved these changes

Assignees

@ntacheva ntacheva

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@ntacheva @dimodi @ikoevska