docs: integrate remaining mxGraph resources #642
Conversation
Remove unused images. Integrate information from the mxGraph API specifications that still applies to maxGraph. Update some JSDoc accordingly.
WalkthroughThe pull request involves documentation updates across multiple files. In Changes
Assessment against linked issues
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (4)
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
packages/website/docs/development/high-level-api-description.md (2)
33-33: Fix grammar in sentence.Remove the duplicate determiner "a" before "The".
-- It refers to a `GraphDataModel` which contains `Cell`s and caches the state of the cells in a `GraphView` - The cells are painted using a `CellRenderer` ++ It refers to a `GraphDataModel` which contains `Cell`s and caches the state of the cells in a `GraphView`. The cells are painted using a `CellRenderer`🧰 Tools
🪛 LanguageTool
[grammar] ~33-~33: Two determiners in a row. Choose either “a” or “The”.
Context: ...s and caches the state of the cells in aGraphView- The cells are painted using aCellRenderer...(DT_DT)
135-136: Update image usage documentation.This section needs to be updated to reflect maxGraph's current state.
Would you like me to help create updated documentation for image handling in maxGraph? I can analyze the codebase to document:
- Current image formats supported
- Image loading mechanisms
- Best practices specific to maxGraph
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
packages/website/old-mxgraph/images/MX_MANUAL_html_1cc55dd3_loop_connector.pngis excluded by!**/*.pngpackages/website/old-mxgraph/images/MX_MANUAL_html_ba4bf13_mxGraph_console.pngis excluded by!**/*.pngpackages/website/old-mxgraph/images/MX_MANUAL_html_m75de608.pngis excluded by!**/*.png
📒 Files selected for processing (3)
packages/core/src/Client.ts(2 hunks)packages/website/docs/development/high-level-api-description.md(1 hunks)packages/website/old-mxgraph/api-specification.txt(0 hunks)
💤 Files with no reviewable changes (1)
- packages/website/old-mxgraph/api-specification.txt
🧰 Additional context used
🪛 LanguageTool
packages/website/docs/development/high-level-api-description.md
[grammar] ~33-~33: Two determiners in a row. Choose either “a” or “The”.
Context: ...s and caches the state of the cells in a GraphView- The cells are painted using aCellRenderer...
(DT_DT)
🔇 Additional comments (1)
packages/core/src/Client.ts (1)
Line range hint
71-81: Verify the accuracy of updated method references.The JSDoc comments have been updated to reference methods from different modules. Let's verify these references exist in the codebase:
✅ Verification successful
All referenced methods and properties exist and are correctly documented
The JSDoc comments accurately reflect the current codebase structure:
Translations.getSpecialBundleis defined inpackages/core/src/util/Translations.tsutils.errorResourceandutils.closeResourceare defined inpackages/core/src/util/Utils.ts🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of referenced methods in the codebase # Check for Translations.getSpecialBundle ast-grep --pattern 'class Translations { $$$ getSpecialBundle($$$) { $$$ } $$$ }' # Check for utils.errorResource and utils.closeResource ast-grep --pattern 'const utils = { $$$ errorResource: $$$, closeResource: $$$, $$$ }' # Alternative pattern if utils is a class ast-grep --pattern 'class utils { $$$ static errorResource = $$$; static closeResource = $$$; $$$ }'Length of output: 303
Script:
#!/bin/bash # Search for translations and utils related code rg -i "translations.*getspecialbundle" -A 3 rg "(errorResource|closeResource)" -A 2 # Search for type definitions and interfaces ast-grep --pattern 'interface $_ { $$$ (errorResource|closeResource) $$$ }' # Search for any exports containing these names rg "export.*(Translations|utils).*(errorResource|closeResource|getSpecialBundle)"Length of output: 2412
packages/website/docs/development/high-level-api-description.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
packages/website/docs/development/high-level-api-description.md (2)
9-9:⚠️ Potential issueFix malformed link to mxGraph API Specification.
The link to the mxGraph specification is malformed (missing parenthesis).
-The following is adapted from the [mxGraph API Specification]https://github.com/jgraph/graph/blob/v4.2.2/javascript/src/js/index.txt). +The following is adapted from the [mxGraph API Specification](https://github.com/jgraph/graph/blob/v4.2.2/javascript/src/js/index.txt).🧰 Tools
🪛 Markdownlint (0.37.0)
9-9: null
Bare URL used(MD034, no-bare-urls)
121-136:⚠️ Potential issueUpdate translation documentation to reflect current implementation.
The translations section requires significant updates to match the current implementation.
Please update this section to include:
- Current resource file structure and extensions
- Correct path for translation files
- Current language configuration via
Client.languages- Modern features like language fallback
- Support for encoded and non-encoded resource files
🧹 Nitpick comments (4)
packages/website/docs/development/high-level-api-description.md (4)
1-3: Expand the frontmatter description.The current description only mentions releases, but this document is primarily about the high-level API. Consider updating it to better reflect the document's content:
-description: Explain how to do a release of maxGraph. +description: High-level API description of maxGraph, including its structure, components, and configuration.
33-34: Fix article usage and improve sentence structure.There's a grammatical issue with article usage and sentence structure.
-It refers to a `GraphDataModel` which contains `Cell`s and caches the state of the cells in a `GraphView` -The cells are painted using a `CellRenderer` based on the appearance defined in `Stylesheet` +It refers to a `GraphDataModel` which contains `Cell`s and caches the state of the cells in a `GraphView`. +These cells are painted using a `CellRenderer` based on the appearance defined in `Stylesheet`.🧰 Tools
🪛 LanguageTool
[grammar] ~33-~33: Two determiners in a row. Choose either “a” or “The”.
Context: ...s and caches the state of the cells in aGraphView- The cells are painted using aCellRenderer...(DT_DT)
79-84: Add code examples for configuration.Consider adding code examples to demonstrate how to set these global variables:
// Example configuration window.BasePath = '/static/maxgraph'; window.ImageBasePath = '/static/maxgraph/images'; window.Language = 'en'; window.DefaultLanguage = 'en';
88-88: Fix grammar in the reserved words explanation.Add the missing article "it" for better readability.
-The __ prefix was used for all classes and objects in Graph. Some remains in some properties of objects and classes defined in `maxGraph`. +The __ prefix was used for all classes and objects in Graph. It still remains in some properties of objects and classes defined in `maxGraph`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~88-~88: Possible missing article found.
Context: ...was used for all classes and objects in Graph. Some remains in some properties of obj...(AI_HYDRA_LEO_MISSING_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/website/docs/development/high-level-api-description.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/website/docs/development/high-level-api-description.md
[grammar] ~33-~33: Two determiners in a row. Choose either “a” or “The”.
Context: ...s and caches the state of the cells in a GraphView- The cells are painted using aCellRenderer...
(DT_DT)
[uncategorized] ~88-~88: Possible missing article found.
Context: ...was used for all classes and objects in Graph. Some remains in some properties of obj...
(AI_HYDRA_LEO_MISSING_THE)
🪛 Markdownlint (0.37.0)
packages/website/docs/development/high-level-api-description.md
9-9: null
Bare URL used
(MD034, no-bare-urls)
⏰ 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 (1)
packages/website/docs/development/high-level-api-description.md (1)
44-69: Well-documented event system and key bindings!The documentation clearly explains the three types of events and their handling mechanisms, followed by a comprehensive list of key bindings.
1 participant
Remove unused images.
Integrate information from the mxGraph API specifications that still applies to maxGraph.
Update some JSDoc accordingly.
Notes
Closes #615
Summary by CodeRabbit
maxGraphlibrary.Clientclass for clarity.