docs: integrate contents from the mxGraph Java manual#624
Conversation
Add a few items to the content already migrated from the mxGraph JavaScript manual. Remove of the mxGraph Java manual, as its content has been fully integrated into the documentation.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/website/docs/manual/index.md (3)
29-29: Improve wording clarityThe phrase "component part" is redundant. Consider simplifying while maintaining the helpful hyperlink:
-Developers integrating the library in their application should read the section ["Pre-requisites" below](#pre-requisites-for-maxgraph). Given that `maxGraph` is a component part of your application, you must understand how JavaScript web applications are constructed at an architectural level, and how to program both in JavaScript, and any server-side languages used. +Developers integrating the library in their application should read the section ["Pre-requisites" below](#pre-requisites-for-maxgraph). Given that `maxGraph` is a component of your application, you must understand how JavaScript web applications are constructed at an architectural level, and how to program both in JavaScript, and any server-side languages used.
42-42: Fix grammatical errorAdd the missing apostrophe in "user's screen":
-As the number of cells visible on the users screen climbs into the hundreds, redrawing slows on most browsers beyond acceptable levels. +As the number of cells visible on the user's screen climbs into the hundreds, redrawing slows on most browsers beyond acceptable levels.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: .... As the number of cells visible on the users screen climbs into the hundreds, redraw...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
41-45: Great addition of performance considerations!The new section about technology disadvantages and complexity management provides valuable context for developers. Consider adding a link to the complexity management section when it's mentioned in line 45 for easier navigation.
-Complexity management is described in a later section of this user manual. +Complexity management is described in [a later section](#complexity-management) of this user manual.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: .... As the number of cells visible on the users screen climbs into the hundreds, redraw...(AI_HYDRA_LEO_APOSTROPHE_S_XS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
packages/website/old-mxgraph/images/mx_man_stencil_loaded.pngis excluded by!**/*.png
📒 Files selected for processing (2)
packages/website/docs/manual/index.md(1 hunks)packages/website/old-mxgraph/manual_javavis.html(0 hunks)
💤 Files with no reviewable changes (1)
- packages/website/old-mxgraph/manual_javavis.html
🧰 Additional context used
🪛 LanguageTool
packages/website/docs/manual/index.md
[style] ~30-~30: This phrase is redundant. Consider writing “component” or “part”.
Context: ...r-maxgraph). Given that maxGraph is a component part of your application, you must understan...
(COMPONENT_PART)
[uncategorized] ~42-~42: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: .... As the number of cells visible on the users screen climbs into the hundreds, redraw...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (1)
packages/website/docs/manual/index.md (1)
37-37: LGTM!Clear explanation of the technology independence advantage.
1 participant
Add a few items to the content already migrated from the mxGraph JavaScript manual.
Remove of the mxGraph Java manual, as its content has been fully integrated into the documentation.
Notes
Closes #614
Summary by CodeRabbit
maxGraphwith improved clarity