Docs: fix typos

[omahs]

Docs: fix typos

[coderabbitai]

Walkthrough

The recent changes focus on improving the clarity and grammatical accuracy of the documentation for CKEditor tutorials and tests. These adjustments include fixing typos, correcting grammatical errors, and enhancing the overall readability of the text. No changes were made to the declarations of exported or public entities, ensuring that the functionality remains consistent with previous versions.

Changes

File Path	Change Summary
docs/tutorials/abbreviation-plugin-tutorial/...	Corrected typos and improved grammatical consistency in the documentation for the abbreviation plugin tutorial.
docs/tutorials/crash-course/data-conversion.md	Fixed a grammatical error in the explanation of downcasts for HTML representations in an editor.
docs/tutorials/index.md	Updated the meta-description field by correcting the possessive pronoun.
tests/manual/abbreviation-level-3.md	Removed a duplicated article to enhance the clarity of the instruction related to loading plugins.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 18ede1e and 067b99e.

Files selected for processing (5)

• docs/tutorials/abbreviation-plugin-tutorial/abbreviation-plugin-level-1.md (3 hunks)
• docs/tutorials/abbreviation-plugin-tutorial/abbreviation-plugin-level-3.md (1 hunks)
• docs/tutorials/crash-course/data-conversion.md (1 hunks)
• docs/tutorials/index.md (1 hunks)
• tests/manual/abbreviation-level-3.md (1 hunks)

Files not reviewed due to errors (2)

• docs/tutorials/crash-course/data-conversion.md (no review received)
• tests/manual/abbreviation-level-3.md (no review received)

Additional Context Used

LanguageTool (33)

docs/tutorials/abbreviation-plugin-tutorial/abbreviation-plugin-level-1.md (13)

Near line 31: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nds, and many more. If you want to set up the project yourself, you should...

---

Near line 85: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...h; the toolbar button. * Abbreviation will be the glue that holds the UI and the e...

---

Near line 106: Loose punctuation mark.
Context: ...mported into app.js. AbbreviationUI: ```js // abbreviation/abbreviationui.j...

---

Near line 120: Loose punctuation mark.
Context: ...lled' ); } } `AbbreviationEditing`: js // abbreviation/abbreviationedit...

---

Near line 134: Loose punctuation mark.
Context: ... got called' ); } } `Abbreviation`: js // abbreviation/abbreviation.js ...

---

Near line 182: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ild the project now, refresh the browser and you should see that the `AbbreviationEd...

---

Near line 195: Possible missing comma found.
Context: ... the view layer.} In the model, inline elements such as <abbr>, are represented as at...

---

Near line 195: Possible missing article found.
Context: ... will need to make sure that we can add abbreviation attribute to the text node. {@img asset...

---

Near line 200: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ...efining the model's schema. Thanks to a couple lines of code, we will allow all text nodes t...

---

Near line 241: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ... the abbreviation is a little bit tricky, because we need to make sure that its value is ...

---

Near line 290: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...om the content and use it in the model. We can do that thanks to a callback functi...

---

Near line 368: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...le to use in the toolbar configuration. We can now simply add it to the toolbar in...

---

Near line 401: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...hould happen after the user clicks it. We will use the insertContent() method t...

docs/tutorials/abbreviation-plugin-tutorial/abbreviation-plugin-level-3.md (6)

Near line 11: Possible missing article found.
Context: ...ch will additionally grab the text from user's selection, and insert it into our for...

---

Near line 19: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ho rely on keyboards for navigation. We want to ensure that pressing Tab and...

---

Near line 32: Possible missing comma found.
Context: ...coming from the rendered view element. Finally let's add the destroy() method, and d...

---

Near line 197: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ield when the selection is not collapsed, because it would be hard to change the text of ...

---

Near line 197: To elevate your writing, try using a synonym here.
Context: ...n is not collapsed, because it would be hard to change the text of the abbreviation ...

---

Near line 266: Possible missing comma found.
Context: ...l, a command not only executes an action but also automatically reacts when any chan...

docs/tutorials/crash-course/data-conversion.md (1)

Near line 30: It appears that a comma is missing.
Context: ...ion is a bit more complicated. In this chapter we will learn more about data conversio...

docs/tutorials/index.md (3)

Near line 15: Possible typo: you repeated a word
Context: ... with the {@link tutorials/crash-course/editor Editor and configuration} tutorial, explaining...

---

Near line 15: Possible typo: you repeated a word
Context: ...bles} and {@link tutorials/crash-course/keystrokes keystrokes} and how to {@link tutorials/crash-cour...

---

Near line 19: In American English, “take a look” is more commonly used.
Context: ...velop advanced CKEditor 5 plugins, have a look at the Creating Abbreviation Plugin thr...

tests/manual/abbreviation-level-3.md (10)

Near line 18: ‘On top of that’ might be wordy. Consider a shorter alternative.
Context: ...et up a basic CKEditor 5 instance. On top of that, we will need: * The [`@ckeditor/ckedi...

---

Near line 21: Possible missing comma found.
Context: ...mjs.com/package/@ckeditor/ckeditor5-ui) package which contains the UI library and frame...

---

Near line 158: “our” (belonging to us) seems less likely than “out” (outside).
Context: ...ionUI` will be responsible for the UI - our dialog box (with two input fields for t...

---

Near line 253: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ebuild your project, refresh the browser and you should see that the `AbbreviationEd...

---

Near line 302: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...lement. In downcast conversion, we will need to use our conversionApi to get the titl...

---

Near line 388: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...he abbreviation value into the command. We will use the {link module:engine/model/...

---

Near line 388: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... model, along with the title attribute. We will also need to give it a position of...

---

Near line 446: Consider a shorter alternative to avoid wordiness.
Context: ...} ``` You can now execute this command in order to insert an abbreviation. Try this out in...

---

Near line 464: Possible typo: you repeated a word
Context: ...@link framework/architecture/ui-library#view view} class. We will also get the `ButtonVie...

---

Near line 464: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...eledInputText()andsubmitHandler()`. We will use 'check' and 'cancel' icons for...

Additional comments not posted (10)

docs/tutorials/index.md (1)

6-6: The change in the meta-description improves clarity.

docs/tutorials/abbreviation-plugin-tutorial/abbreviation-plugin-level-1.md (4)

59-59: The change is clear and correctly formatted.

---

87-87: The change is clear and correctly formatted.

---

193-193: The change is clear and correctly formatted.

---

196-196: The change is clear and correctly formatted.

docs/tutorials/abbreviation-plugin-tutorial/abbreviation-plugin-level-3.md (5)

22-22: Improved clarity and grammar.

---

Line range hint 32-32: Added comma for better readability.

---

Line range hint 197-197: Removed comma before an essential 'because' clause.

---

Line range hint 266-266: Added comma for better readability.

---

Line range hint 11-11: Added missing article for grammatical correctness.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.