Skip to content

Rewrite Content Editor development guide

Enrique Alcántara requested to merge docs/332480-improve-content-editor-architecture-and-usage-guidelines into master

What does this MR do?

This Merge Request rewrites the Content Editor’s development guide documentation. The following motivations drive the changes in this merge request:

  • The API to include the Content Editor in a feature, for instance in Wikis or issues, changed in 14.1.
  • We need to document the Content Editor’s architectural decisions without overlapping with Tiptap or ProseMirror documentation.

The implementation guide attempts to describe the architectural decisions that affect every feature implemented in the Content Editor. It relies heavily on hyperlinks to Tiptap’s and ProseMirror’s documentation to explain how we intend to use those libraries in the Content Editor.

What doesn’t this MR cover?

There are two aspects of the Content Editor’s architecture that are undergoing significant changes in %14.3: The Markdown Serializer and the Golden Master specs. This MR defers the documentation of these concerns until the new implementations are delivered.

Related issues

This MR addresses #335895 (closed) and #332480 (closed)

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Enrique Alcántara

Merge request reports