Skip to content

docs: explain that the mxGraph migration guide is no longer updated - #783

Merged
tbouffard merged 2 commits into
mainfrom
docs/mxgraph_migration_guide_no_update
Apr 26, 2025
Merged

docs: explain that the mxGraph migration guide is no longer updated#783
tbouffard merged 2 commits into
mainfrom
docs/mxgraph_migration_guide_no_update

Conversation

@tbouffard

@tbouffard tbouffard commented Apr 26, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated the migration guide with a clear warning about its applicability up to maxGraph version 0.18.0.
    • Added guidance for users migrating to newer versions, including a recommendation to review the changelog and migrate incrementally.
    • Included a note directing users to GitHub discussions for community support.
    • Removed outdated warnings and calls for feedback.

@tbouffard tbouffard added the documentation Improvements or additions to documentation label Apr 26, 2025
@coderabbitai

coderabbitai Bot commented Apr 26, 2025 •
edited
Loading

Copy link
Copy Markdown

Walkthrough

The migration guide for transitioning from mxGraph to maxGraph has been updated. A new warning block has been added at the top, specifying that the guide is accurate only up to maxGraph version 0.18.0 and does not address breaking API changes introduced in later versions. The warning advises users of newer versions to consult the changelog and consider incremental migration. An additional note directs users to GitHub discussions for community support. The previous "under construction" warning and requests for feedback were removed, and the guide's outline was repositioned below the new warning.

Changes

File(s) Change Summary
packages/website/docs/usage/migrate-from-mxgraph.md Added a version-specific warning and community support note; removed outdated warnings and feedback requests; repositioned the guide outline.

Possibly related PRs

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c0f6740 and a4ea0c6.

📒 Files selected for processing (1)
  • 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
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

coderabbitai[bot]
coderabbitai Bot reviewed Apr 26, 2025
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/website/docs/usage/migrate-from-mxgraph.md (1)

11-22: Use a warning admonition and improve clarity
The block is a user-facing caution about guide applicability—not a critical error—so :::warning (or :::caution) is more appropriate than :::danger. Also tightening the phrasing will make the note clearer.

Apply this diff:

--- a/packages/website/docs/usage/migrate-from-mxgraph.md
+++ b/packages/website/docs/usage/migrate-from-mxgraph.md
@@ -11,7 +11,7 @@
-:::danger
+:::warning
 As of version `0.18.0`, this migration guide isn't updated with the latest `maxGraph` API changes, particularly breaking ones.
+As of version `0.18.0`, this migration guide is not updated to cover breaking `maxGraph` API changes introduced after v0.18.0.
 
 When migrating from `mxGraph` to a `maxGraph` version newer than 0.18.0:
 1. Use this guide as your foundation
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6128c73 and c0f6740.

📒 Files selected for processing (1)
  • packages/website/docs/usage/migrate-from-mxgraph.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (1)
packages/website/docs/usage/migrate-from-mxgraph.md (1)

25-29: Confirm outline placement and link accuracy
The breakdown of sections is now positioned immediately after the warning block, improving discoverability. The numbered links correspond correctly to existing headings.

@sonarqubecloud

sonarqubecloud Bot commented Apr 26, 2025

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@tbouffard
tbouffard merged commit af89ab5 into main Apr 26, 2025
@tbouffard
tbouffard deleted the docs/mxgraph_migration_guide_no_update branch April 26, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard