docs: reorganize and improve the manual pages #622
Conversation
Use markdown instead of HTML code Rename images to clarify what they describe Rename all images to remove mx prefixes model-and-cells.md: remove ref to mxGraph model-and-cells.md: layers example model-and-cells.md: finish "The Model Change Methods" (end line 141) model-and-cells.md: add todo
…uce a docusaurus plugin to create static redirects
|
Warning Rate limit exceeded@tbouffard has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 33 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis pull request introduces comprehensive documentation updates for the Changes
Assessment against linked issues
Possibly related PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (6)
packages/website/docs/manual/index.md (1)
21-22: Consider clarifying the distinction between maxGraph and mathematical graphs.The explanation of graphs could be more precise. Consider adding a brief explanation of what makes maxGraph different from other graph visualization libraries.
-`maxGraph` is a JavaScript component that provides features aimed at applications that display interactive [diagrams](http://en.wikipedia.org/wiki/Diagram) and graphs. -Note by graphs we mean [mathematical graphs](http://en.wikipedia.org/wiki/Graph_(mathematics)), not necessarily [charts](http://en.wikipedia.org/wiki/Charts) (although some charts are graphs). +`maxGraph` is a JavaScript component specialized in visualizing and manipulating interactive [diagrams](http://en.wikipedia.org/wiki/Diagram) and [mathematical graphs](http://en.wikipedia.org/wiki/Graph_(mathematics)). Unlike charting libraries that focus on data visualization, maxGraph excels at representing and manipulating interconnected entities through vertices and edges.packages/website/docs/manual/model-and-transactions.md (2)
33-44: Improve code example formatting and comments.The code example could be more instructive with better formatting and comments.
// Adds cells to the model in a single step graph.getModel().beginUpdate(); try { - const v1 = graph.insertVertex(parent, null, 'Hello,', 20, 20, 80, 30); - const v2 = graph.insertVertex(parent, null, 'World!', 200, 150, 80, 30); - graph.insertEdge(parent, null, '', v1, v2); + // Create first vertex with label "Hello," + const v1 = graph.insertVertex(parent, null, 'Hello,', 20, 20, 80, 30); + + // Create second vertex with label "World!" + const v2 = graph.insertVertex(parent, null, 'World!', 200, 150, 80, 30); + + // Connect the vertices with an edge + graph.insertEdge(parent, null, '', v1, v2); } finally { // Updates the display graph.getModel().endUpdate(); }
75-77: Enhance explanation of transaction nesting.The explanation of transaction nesting could be clearer with an example.
-The sub-transaction in the blue block above refers to the fact that transactions can be nested. -That is, there is a counter in the model that increments for every `beginUpdate` call and decrements for every `endUpdate` call. -After increasing to at least 1, when this count reaches 0 again, the model transaction is considered complete and the event notifications of the model change are fired. +Transactions in maxGraph can be nested, which means you can have transactions within transactions. The model maintains a counter that: +1. Increments with each `beginUpdate` call +2. Decrements with each `endUpdate` call +3. Fires event notifications when the counter returns to 0 + +For example: +```javascript +graph.getModel().beginUpdate(); // counter = 1 +try { + // Some changes... + graph.getModel().beginUpdate(); // counter = 2 + try { + // Nested changes... + } finally { + graph.getModel().endUpdate(); // counter = 1 + } + // More changes... +} finally { + graph.getModel().endUpdate(); // counter = 0, events fire +} +```packages/website/docs/manual/group-and-complexity-management.md (2)
20-33: Enhance the introduction to grouping concepts.The introduction to grouping could be more structured and clearer.
-Grouping, within `maxGraph`, is the concept of logically associating cells with one another. -This is commonly referred to as the concept of sub-graphs in many graph toolkits. -Grouping involves one or more vertices or edges becoming children of a parent vertex or edge (usually a vertex) in the graph model data structure. -Grouping allows `maxGraph` to provide a number of useful features: +## What is Grouping? + +Grouping in `maxGraph` is a powerful feature that allows you to: +1. Logically organize cells (vertices and edges) into hierarchical structures +2. Create sub-graphs that can be managed as single units +3. Improve visualization by collapsing complex parts of your graph + +When you group cells, they become children of a parent cell (typically a vertex) in the graph model. This hierarchical structure enables several key features:🧰 Tools
🪛 LanguageTool
[uncategorized] ~26-~26: Consider adding a hyphen.
Context: ...e seen by clicking the small "-" in the top left corner of the group cells of the swimla...(TOP_LEFT_CORNER)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...a complete graph. In the User Objects section we saw the "check inventor" vertex as a...(AI_HYDRA_LEO_MISSING_COMMA)
83-84: Clarify the folding terminology.The explanation of folding could be more precise.
-Folding is the collective term we use for expanding and collapsing groups. -We say a cell is folded by making its child vertices invisible. There are a number of functions relating to this feature: +Folding refers to the ability to expand or collapse groups of cells: +- **Collapsing** a group hides its child vertices and shows a simplified representation +- **Expanding** a group reveals all its child vertices and their connections + +This feature is controlled through several functions:packages/website/docs/usage/migrate-from-mxgraph.md (1)
Line range hint
49-54: Add a migration checklist for better guidance.Consider adding a checklist to help users track their migration progress.
+## Migration Checklist + +Use this checklist to track your migration progress: + +### Setup Changes +- [ ] Replace mxgraph dependency with maxgraph@core +- [ ] Update initialization code +- [ ] Remove TypeScript-related configurations + +### Code Changes +- [ ] Update class names (remove 'mx' prefix) +- [ ] Migrate event handling +- [ ] Update styling approach +- [ ] Register required codecs + The `maxGraph` APIs are not fully compatible with the `mxGraph` APIs, but the `maxGraph` APIs are close to the former `mxGraph` APIs. The concepts are the same, so experienced `mxGraph` users should be able to switch from `mxGraph` to `maxGraph` without problems.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (10)
package-lock.jsonis excluded by!**/package-lock.jsonpackages/website/docs/manual/assets/model/drill_down_inside.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/drill_down_menu.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/drill_down_top_level.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/group_structure_complex_example.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/group_structure_hello-world-example.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/layers_example.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/layout_overlap.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/properties_vertex.pngis excluded by!**/*.pngpackages/website/docs/manual/assets/model/simple_workflow.pngis excluded by!**/*.png
📒 Files selected for processing (8)
packages/website/docs/manual/cells.md(1 hunks)packages/website/docs/manual/group-and-complexity-management.md(1 hunks)packages/website/docs/manual/index.md(2 hunks)packages/website/docs/manual/model-and-cells.md(0 hunks)packages/website/docs/manual/model-and-transactions.md(1 hunks)packages/website/docs/usage/migrate-from-mxgraph.md(1 hunks)packages/website/docusaurus.config.ts(1 hunks)packages/website/package.json(1 hunks)
💤 Files with no reviewable changes (1)
- packages/website/docs/manual/model-and-cells.md
🧰 Additional context used
🪛 LanguageTool
packages/website/docs/manual/cells.md
[uncategorized] ~22-~22: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...nd undo, using the cell makes the change but there is no record of the change. This ...
(COMMA_COMPOUND_SENTENCE_2)
[grammar] ~33-~33: Possible subject-verb agreement error.
Context: ...owing section includes screenshots that relates to the mxGraph style mechanism. The s...
(NNS_THAT_AGREEMENT)
[formatting] ~52-~52: Consider inserting a comma after an introductory phrase for better readability.
Context: ...eter of insertVertex or insertEdge. In this case the default style would be used for tho...
(IN_THAT_CASE_COMMA)
[grammar] ~103-~103: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...r the array of cells, encapsulated in a begin/end update. - **Graph.getCellStyle(cell...
(PREPOSITION_VERB)
[uncategorized] ~141-~141: Consider adding a hyphen.
Context: ...sition of a vertex is the offset of the top left point of the bounding rectangle of the ...
(TOP_LEFT_CORNER)
[uncategorized] ~141-~141: Consider adding a hyphen.
Context: ...bounding rectangle of the parent to the top left point of the bounding rectangle of the ...
(TOP_LEFT_CORNER)
[uncategorized] ~142-~142: Possible missing article found.
Context: ...oo much detail, if a cell does not have cell parent, the graph container is its pare...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~158-~158: Consider adding a hyphen.
Context: ...parent, (1, 1) places the origin in the bottom right corner of the parent. The same relative...
(TOP_LEFT_CORNER)
[uncategorized] ~167-~167: Do not mix variants of the same word (‘co-ordinate’ and ‘coordinate’) within a single text.
Context: ...the target end of the edge, at 1. The y co-ordinate is the pixel offset orthogonal from the...
(EN_WORD_COHERENCY)
[uncategorized] ~175-~175: The preposition ‘to’ seems more likely in this position.
Context: ...eateEdge() the geometry is set relative for every edge created using this prototype...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[grammar] ~187-~187: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... cell to the specified bounds, within a begin/end update call. - **Graph.resizeCells(...
(PREPOSITION_VERB)
[grammar] ~189-~189: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...g entry in the bounds array, within a begin/end update call. ## User Objects The...
(PREPOSITION_VERB)
[uncategorized] ~208-~208: Possible missing comma found.
Context: ...nt-end server linked to the application server and the user's web application requests...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~217-~217: Possible missing preposition found.
Context: ... as well as changing the connections 2. edit the user objects of the cells (vertices...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~223-~223: Possible missing comma found.
Context: ...ect properties of the "Check Inventory" diamond you will see this dialog: 
[uncategorized] ~231-~231: When ‘application-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...y is actually checked. This might be an application specific mechanism for both the server and clien...
(SPECIFIC_HYPHEN)
[uncategorized] ~239-~239: This expression is ususally spelled with a hyphen
Context: ... in mind that the above example is very domain specific, it is there to explain how the user ob...
(SPECIFIC_HYPHEN)
[uncategorized] ~246-~246: Possible missing comma found.
Context: ...raph` is the primary API for using this library and the same concept applies to cells. ...
(AI_HYDRA_LEO_MISSING_COMMA)
packages/website/docs/manual/model-and-transactions.md
[style] ~31-~31: Consider shortening or rephrasing this to strengthen your wording.
Context: ...xGraph` uses a transactional system for making changes to the model. In the [HelloWorld example](...
(MAKE_CHANGES)
[typographical] ~57-~57: Consider adding a comma after ‘Technically’ for more clarity.
Context: ...o the specified parent cell. :::note Technically you do not have to surround your change...
(RB_LY_COMMA)
[style] ~59-~59: This phrase is redundant. Consider using “outside”.
Context: ...n_ and end update calls. Changes made outside of this update scope take immediate effect...
(OUTSIDE_OF)
[grammar] ~79-~79: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...e can (and should) be surrounded by the begin/end combination. This provides the abil...
(PREPOSITION_VERB)
[style] ~84-~84: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ired. In automatic layouting, the user makes changes to the graph, usually through the user int...
(MAKE_CHANGES)
[grammar] ~86-~86: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... change. Because all changes within the begin/end update are made directly to the gra...
(PREPOSITION_VERB)
[style] ~90-~90: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...is and acts upon it. This method should only be used for parts of compound model cha...
(ONLY_EXCLUSIVELY_STYLE)
[typographical] ~113-~113: Consider adding a comma here.
Context: ...that these are not core API methods, as usual these methods are on the maxGraph cla...
(AS_ALWAYS_COMMA)
[grammar] ~138-~138: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...s a new vertex into the model, within a begin/end update call. - **Graph.insertEdge(p...
(PREPOSITION_VERB)
[grammar] ~139-~139: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...rts a new edge into the model, within a begin/end update call. `Graph.insertVertex(...
(PREPOSITION_VERB)
[typographical] ~144-~144: Consider adding a comma here.
Context: ...ddress the group structure shortly, but for now use graph.getDefaultParent() as your ...
(FOR_NOW_COMMA)
[uncategorized] ~145-~145: Loose punctuation mark.
Context: ...s used in the HelloWorld example. - id: this is a global unique identifier that...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~147-~147: Loose punctuation mark.
Context: ...ds and ensure they are unique. - value: this is the user object of the cell. Us...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~149-~149: Loose punctuation mark.
Context: ... vertex or edge. - x, y, width, height: as the names suggest, these are the x a...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~149-~149: Consider adding a hyphen.
Context: ..., these are the x and y position of the top left corner of the vertex and its width and ...
(TOP_LEFT_CORNER)
[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...rtex and its width and height. - style: the style description to be applied to ...
(UNLIKELY_OPENING_PUNCTUATION)
[typographical] ~150-~150: Consider adding a comma after this introductory phrase.
Context: ...in more detail shortly, but at a simple level this parameter is a string that follows...
(AS_A_NN_COMMA)
packages/website/docs/manual/index.md
[style] ~30-~30: This phrase is redundant. Consider writing “component” or “part”.
Context: ...dquo; below. Given that maxGraph is a component part of your application, you must understan...
(COMPONENT_PART)
[typographical] ~72-~72: Consider adding a comma after this introductory phrase.
Context: ...y SVG for all supported browsers. As a developer you are not exposed to browser specific...
(AS_A_NN_COMMA)
[locale-violation] ~85-~85: In American English, “take a look” is more commonly used.
Context: ...t bar charts, pie charts, Gantt charts, have a look at the [Google Charts](http://code.goog...
(HAVE_A_LOOK)
[style] ~114-~114: Consider a shorter alternative to avoid wordiness.
Context: ...ions rely on a round-trip to the server in order to form the display, not only the base dis...
(IN_ORDER_TO_PREMIUM)
[style] ~132-~132: Consider shortening or rephrasing this to strengthen your wording.
Context: ...on might involve only allowing users to make changes to certain cells in certain positions, to ...
(MAKE_CHANGES)
[uncategorized] ~147-~147: When ‘domain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...lgorithms, these being often applied in domain specific tasks. Techniques such as clustering, d...
(SPECIFIC_HYPHEN)
packages/website/docs/manual/group-and-complexity-management.md
[uncategorized] ~26-~26: Consider adding a hyphen.
Context: ...e seen by clicking the small "-" in the top left corner of the group cells of the swimla...
(TOP_LEFT_CORNER)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...a complete graph. In the User Objects section we saw the "check inventor" vertex as a...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~53-~53: It appears that a comma is missing.
Context: ...tasks assigned to those people. In this example the logical group structure looks like ...
(DURING_THAT_TIME_COMMA)
[grammar] ~68-~68: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... cells to the specified group, within a begin/end update - **Graph.ungroupCells(cells...
(PREPOSITION_VERB)
[grammar] ~70-~70: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... deleted. The operation occurs within a begin/end update. ## Complexity Management ...
(PREPOSITION_VERB)
[grammar] ~87-~87: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... state of the specified cells, within a begin/end update. **Folding related function...
(PREPOSITION_VERB)
[uncategorized] ~111-~111: Possible missing comma found.
Context: ...these three concepts. \ In its expanded state the upper group cell displays a small b...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~111-~111: Did you mean the adjective “left-hand”?
Context: ...up cell displays a small box in the top left hand corner with a "-" character inside. Thi...
(MISSING_HYPHEN)
[uncategorized] ~131-~131: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...model/drill_down_menu.png) An example top level workflow This simple workflow consist...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~133-~133: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... This simple workflow consists of three high level steps. Obviously, the individual steps ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~136-~136: Possible missing comma found.
Context: ...e Bug cell. Under the Solve Bug vertex we have created a number of children to...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~145-~145: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ot cell, if any, the new root cell. - Graph.home(): Exits all groups, making the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~160-~160: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rings you back to the original 3 vertex top level graph. ### Layering and Filtering In...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~160-~160: Possible agreement error. The noun ‘graph’ seems to be countable.
Context: ...back to the original 3 vertex top level graph. ### Layering and Filtering In `maxG...
(CD_NN)
[typographical] ~179-~179: It seems that a comma is missing.
Context: ...e children of the root cell. To change order we use Graph.orderCells. - **Graph.or...
(IN_ORDER_TO_VB_COMMA)
[grammar] ~180-~180: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...blings, depending on the flag, within a begin/end update. A sibling cell in `maxGrap...
(PREPOSITION_VERB)
🪛 Markdownlint (0.37.0)
packages/website/docs/manual/cells.md
46-46: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
134-134: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
147-147: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
154-154: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
163-163: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
204-204: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
227-227: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
44-44: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
161-161: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
202-202: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
225-225: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
packages/website/docs/manual/model-and-transactions.md
50-50: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
51-51: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
52-52: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
53-53: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
packages/website/docs/manual/index.md
106-106: null
Bare URL used
(MD034, no-bare-urls)
94-94: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
122-122: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
137-137: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
packages/website/docs/manual/group-and-complexity-management.md
48-48: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
103-103: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
107-107: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
131-131: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
152-152: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
174-174: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
46-46: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
55-55: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
101-101: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
105-105: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
129-129: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
150-150: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
157-157: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
172-172: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: build (windows-2022)
- GitHub Check: build
- GitHub Check: build (macos-14)
- GitHub Check: build (ubuntu-22.04)
🔇 Additional comments (2)
packages/website/docusaurus.config.ts (1)
164-177: LGTM! Consider adding more redirects for other renamed pages.The plugin configuration is correct and aligns with the documentation reorganization. However, since the PR mentions multiple renamed pages, consider adding more redirects to ensure all old documentation URLs remain accessible.
Let's check for other potential redirects needed:
✅ Verification successful
Current redirect configuration is complete and sufficient
The codebase analysis shows that:
- The migration from
model-and-cellstomodel-and-transactionsis complete- No other documentation pages appear to have been renamed
- The current redirect configuration adequately handles all necessary URL mappings
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Find renamed .md files in the docs directory to identify potential redirects needed # Look for git rename operations in the docs directory git log --follow --name-status -- 'packages/website/docs/**/*.md' | grep -E '^R|^D'Length of output: 0
Script:
#!/bin/bash # Search for any remaining references to "model-and-cells" echo "=== Searching for 'model-and-cells' references ===" rg "model-and-cells" --type md -l # List all markdown files in the docs directory echo -e "\n=== Current documentation files ===" fd -e md . packages/website/docs/ # Search for other redirect patterns in config echo -e "\n=== Searching for redirect patterns ===" rg "redirects.*from.*to" packages/website/Length of output: 1231
packages/website/package.json (1)
17-17: LGTM! Dependency version is consistent.The plugin dependency is correctly added with a version matching other Docusaurus packages.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
packages/website/docs/manual/index.md (2)
35-39: Improve formatting of advantages section.Consider using more concise bullet points and consistent punctuation:
The key advantages of this technology are: -• That no third-party plug-ins are required. This removes plug-in vendor dependence. -• The technologies involved are open and there are many open implementations, no one vendor can remove a product or technology that leaves your application unworkable in practise. -• Standardized technologies, meaning your application is deployable to the maximum number of browser users without need for additional configuration or installation at the client computer. +• No third-party plug-ins required, eliminating vendor dependence +• Open technologies with multiple implementations, ensuring long-term viability +• Standardized web technologies, enabling broad deployment without client-side configuration
45-64: Improve organization and formatting of applications list.Consider grouping related applications and using consistent capitalization:
Example applications for a graph visualization library include: -• process diagrams -• workflow and BPM visualization -• flowcharts -• traffic or water flow -• database and WWW visualization -• networks and telecommunications displays -• mapping applications and GIS -• UML diagrams -• electronic circuits -• VLSI -• CAD -• financial and social networks -• data mining -• biochemistry -• ecological cycles -• entity -• cause-effect relationships -• organisational charts -• ... +Business & Process: +• Process diagrams +• Workflow and BPM visualization +• Flowcharts +• Organizational charts + +Technical & Engineering: +• UML diagrams +• Electronic circuits +• VLSI design +• CAD systems + +Networks & Infrastructure: +• Database and WWW visualization +• Network and telecommunications +• Traffic or water flow systems +• Mapping applications and GIS + +Analytics & Science: +• Financial and social networks +• Data mining visualizations +• Biochemistry pathways +• Ecological cycles +• Entity relationshipspackages/website/docs/manual/group-and-complexity-management.md (2)
68-70: Clarify the transaction terminology.The term "begin/end update" might be unclear to new users. Consider adding a brief explanation or link to the transaction documentation.
-• **Graph.groupCells(group, border, cells)**: Adds the specified cells to the specified group, within a begin/end update +• **Graph.groupCells(group, border, cells)**: Adds the specified cells to the specified group. The operation is wrapped in a transaction (begin/end update) to ensure atomic changes. See [Model and Transactions](./model-and-transactions.md) for details.🧰 Tools
🪛 LanguageTool
[grammar] ~68-~68: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... cells to the specified group, within a begin/end update - **Graph.ungroupCells(cells...(PREPOSITION_VERB)
[grammar] ~70-~70: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... deleted. The operation occurs within a begin/end update. ## Complexity Management ...(PREPOSITION_VERB)
136-138: Define technical terms for better understanding.Consider adding brief explanations for technical terms to help new users:
In addition, edges have the concept of **control points**. These are intermediate points along the edge that the edge is drawn as passing through. -The use of control points is sometimes referred to as **edge routing**. +The use of control points is sometimes referred to as **edge routing** - the process of determining the path an edge takes between its source and target vertices.🧰 Tools
🪛 LanguageTool
[uncategorized] ~136-~136: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... This simple workflow consists of three high level steps. Obviously, the individual steps ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
packages/website/docs/manual/cells.md (2)
74-79: Add type annotations to code examples.Consider adding TypeScript type annotations to make the code examples more clear:
-const v1 = graph.insertVertex(parent, null, 'Hello', 20, 20, 80, 30, +const v1: Cell = graph.insertVertex( + parent: Cell, + id: null, + value: 'Hello', + x: 20, + y: 20, + width: 80, + height: 30, { baseStyleNames: ['ROUNDED'], });
102-102: Fix typo in code comment.- baseStyleNames: ['defaultVertex'], // This can be ommited, as it is the default style apply for vertices + baseStyleNames: ['defaultVertex'], // This can be omitted, as it is the default style applied for vertices
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
packages/website/docs/manual/cells.md(1 hunks)packages/website/docs/manual/group-and-complexity-management.md(1 hunks)packages/website/docs/manual/index.md(2 hunks)packages/website/docs/usage/migrate-from-mxgraph.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/website/docs/usage/migrate-from-mxgraph.md
🧰 Additional context used
🪛 LanguageTool
packages/website/docs/manual/index.md
[style] ~30-~30: This phrase is redundant. Consider writing “component” or “part”.
Context: ...dquo; below. Given that maxGraph is a component part of your application, you must understan...
(COMPONENT_PART)
[typographical] ~72-~72: Consider adding a comma after this introductory phrase.
Context: ...y SVG for all supported browsers. As a developer you are not exposed to browser specific...
(AS_A_NN_COMMA)
[locale-violation] ~85-~85: In American English, “take a look” is more commonly used.
Context: ...t bar charts, pie charts, Gantt charts, have a look at the [Google Charts](http://code.goog...
(HAVE_A_LOOK)
[style] ~114-~114: Consider a shorter alternative to avoid wordiness.
Context: ...ions rely on a round-trip to the server in order to form the display, not only the base dis...
(IN_ORDER_TO_PREMIUM)
[style] ~132-~132: Consider shortening or rephrasing this to strengthen your wording.
Context: ...on might involve only allowing users to make changes to certain cells in certain positions, to ...
(MAKE_CHANGES)
[uncategorized] ~147-~147: When ‘domain-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...lgorithms, these being often applied in domain specific tasks. Techniques such as clustering, d...
(SPECIFIC_HYPHEN)
[uncategorized] ~160-~160: Possible missing comma found.
Context: ... maxGraph To benefit fully from this manual you will need to have a reasonable unde...
(AI_HYDRA_LEO_MISSING_COMMA)
packages/website/docs/manual/group-and-complexity-management.md
[uncategorized] ~26-~26: Consider adding a hyphen.
Context: ...e seen by clicking the small "-" in the top left corner of the group cells of the swimla...
(TOP_LEFT_CORNER)
[typographical] ~53-~53: It appears that a comma is missing.
Context: ...tasks assigned to those people. In this example the logical group structure looks like ...
(DURING_THAT_TIME_COMMA)
[grammar] ~68-~68: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... cells to the specified group, within a begin/end update - **Graph.ungroupCells(cells...
(PREPOSITION_VERB)
[grammar] ~70-~70: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... deleted. The operation occurs within a begin/end update. ## Complexity Management ...
(PREPOSITION_VERB)
[grammar] ~90-~90: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... state of the specified cells, within a begin/end update. **Folding related function...
(PREPOSITION_VERB)
[uncategorized] ~114-~114: Possible missing comma found.
Context: ...these three concepts. \ In its expanded state the upper group cell displays a small b...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~114-~114: Did you mean the adjective “left-hand”?
Context: ...up cell displays a small box in the top left hand corner with a "-" character inside. Thi...
(MISSING_HYPHEN)
[uncategorized] ~134-~134: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...model/drill_down_menu.png) An example top level workflow This simple workflow consist...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~136-~136: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... This simple workflow consists of three high level steps. Obviously, the individual steps ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~139-~139: Possible missing comma found.
Context: ...e Bug cell. Under the Solve Bug vertex we have created a number of children to...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~148-~148: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ot cell, if any, the new root cell. - Graph.home(): Exits all groups, making the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~151-~151: Possible missing comma found.
Context: ...x to all first-level cells. Using these functions you can make any group cell in the grou...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~163-~163: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...rings you back to the original 3 vertex top level graph. ### Layering and Filtering In...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~163-~163: Possible agreement error. The noun ‘graph’ seems to be countable.
Context: ...back to the original 3 vertex top level graph. ### Layering and Filtering In `maxG...
(CD_NN)
[uncategorized] ~171-~171: Possible missing comma found.
Context: ...er parents in a deterministic order (by default the order in which you add them). If w...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~182-~182: It seems that a comma is missing.
Context: ...e children of the root cell. To change order we use Graph.orderCells. - **Graph.or...
(IN_ORDER_TO_VB_COMMA)
[grammar] ~183-~183: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...blings, depending on the flag, within a begin/end update. A sibling cell in `maxGrap...
(PREPOSITION_VERB)
[uncategorized] ~194-~194: Possible missing comma found.
Context: ...kages/html/stories/Layers.stories.js)). Here buttons are used to set the visibility ...
(AI_HYDRA_LEO_MISSING_COMMA)
packages/website/docs/manual/cells.md
[uncategorized] ~22-~22: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...nd undo, using the cell makes the change but there is no record of the change. This ...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~23-~23: Possible missing comma found.
Context: ...This can be useful for temporary visual effects such as animations or changes on a mous...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~24-~24: Possible missing comma found.
Context: ...a mouse over, for example. As a general rule though, use the model editing API unles...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...n the styles collection_ In the above image the blue box represents the styles obje...
(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~59-~59: Consider inserting a comma after an introductory phrase for better readability.
Context: ...eter of insertVertex or insertEdge. In this case the default style would be used for tho...
(IN_THAT_CASE_COMMA)
[grammar] ~110-~110: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...r the array of cells, encapsulated in a begin/end update. - **Graph.getCellStyle(cell...
(PREPOSITION_VERB)
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...thandheightvalues are ignored for edges and thexandy` values relate to th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~148-~148: Consider adding a hyphen.
Context: ...sition of a vertex is the offset of the top left point of the bounding rectangle of the ...
(TOP_LEFT_CORNER)
[uncategorized] ~148-~148: Consider adding a hyphen.
Context: ...bounding rectangle of the parent to the top left point of the bounding rectangle of the ...
(TOP_LEFT_CORNER)
[uncategorized] ~149-~149: Possible missing article found.
Context: ...oo much detail, if a cell does not have cell parent, the graph container is its pare...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~165-~165: Consider adding a hyphen.
Context: ...parent, (1, 1) places the origin in the bottom right corner of the parent. The same relative...
(TOP_LEFT_CORNER)
[uncategorized] ~174-~174: Do not mix variants of the same word (‘co-ordinate’ and ‘coordinate’) within a single text.
Context: ...the target end of the edge, at 1. The y co-ordinate is the pixel offset orthogonal from the...
(EN_WORD_COHERENCY)
[uncategorized] ~182-~182: The preposition ‘to’ seems more likely in this position.
Context: ...eateEdge() the geometry is set relative for every edge created using this prototype...
(AI_HYDRA_LEO_REPLACE_FOR_TO)
[grammar] ~194-~194: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ... cell to the specified bounds, within a begin/end update call. - **Graph.resizeCells(...
(PREPOSITION_VERB)
[grammar] ~196-~196: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...g entry in the bounds array, within a begin/end update call. ## User Objects The...
(PREPOSITION_VERB)
[uncategorized] ~215-~215: Possible missing comma found.
Context: ...nt-end server linked to the application server and the user's web application requests...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~224-~224: Possible missing preposition found.
Context: ... as well as changing the connections 2. edit the user objects of the cells (vertices...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~230-~230: Possible missing comma found.
Context: ...ect properties of the "Check Inventory" diamond you will see this dialog: ![Displaying...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~238-~238: When ‘application-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...y is actually checked. This might be an application specific mechanism for both the server and clien...
(SPECIFIC_HYPHEN)
[uncategorized] ~246-~246: This expression is ususally spelled with a hyphen
Context: ... in mind that the above example is very domain specific, it is there to explain how the user ob...
(SPECIFIC_HYPHEN)
[uncategorized] ~253-~253: Possible missing comma found.
Context: ...raph` is the primary API for using this library and the same concept applies to cells. ...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.37.0)
packages/website/docs/manual/index.md
106-106: null
Bare URL used
(MD034, no-bare-urls)
94-94: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
122-122: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
137-137: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
packages/website/docs/manual/group-and-complexity-management.md
48-48: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
106-106: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
110-110: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
134-134: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
155-155: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
177-177: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
46-46: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
55-55: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
104-104: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
108-108: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
132-132: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
153-153: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
160-160: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
175-175: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
packages/website/docs/manual/cells.md
53-53: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
141-141: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
154-154: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
161-161: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
170-170: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
211-211: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
234-234: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: build (windows-2022)
- GitHub Check: build
- GitHub Check: build (macos-14)
- GitHub Check: build (ubuntu-22.04)
🔇 Additional comments (2)
packages/website/docs/manual/index.md (1)
92-92: Add alt text to images for better accessibility.Images should include descriptive alt text to improve accessibility for screen readers and provide context when images fail to load.
packages/website/docs/manual/group-and-complexity-management.md (1)
46-48: Add alt text to images for better accessibility.Images should include descriptive alt text to improve accessibility for screen readers and provide context when images fail to load.
Also applies to: 55-57, 104-106, 108-110, 132-134, 153-155, 160-162, 175-177
🧰 Tools
🪛 Markdownlint (0.37.0)
48-48: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
46-46: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Changes:
Notes
Closes #612
Summary by CodeRabbit
Summary by CodeRabbit
Documentation
maxGraphcovering:mxGraphtomaxGraphChores