{{ message }}
docs: improve library presentation in README and website#1006
Merged
Conversation
- Rewrite intro paragraph to be clearer and developer-focused - Replace mxGraph successor bullet list with a concise paragraph - Add short feature list (10 items with emojis) to README - Add full feature list with categories to the website intro page - Add comparison page with detailed analysis of JointJS, GoJS, React Flow, Cytoscape.js, X6, mxGraph, and diagram-js
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (1)
README.md (1)
7-7: Stale TODO comment — both target files have already been updated in this PR.
[//]: # (TODO apply to core/README.md and website/docs/intro.md)was presumably written before the edits topackages/core/README.mdandpackages/website/docs/intro.mdwere done. Safe to remove.♻️ Proposed removal
-[//]: # (TODO apply to core/README.md and website/docs/intro.md) <!-- copied into packages/core/README.md and packages/website/docs/intro.md -->
…de enough valuable information
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Notes
Initially, this PR includes a page that compares maxGraph with various diagramming libraries, including JointJS, GoJS, React Flow, Cytoscape.js, X6, mxGraph, and diagram-js.
It has been removed as it did not provide enough valuable information, but it could serve as a starting point if someone wants to create such a page.
See https://github.com/maxGraph/maxGraph/blob/8d434b253958871447a5753cc95cf8fb3fb20e73/packages/website/docs/comparison.md
Summary by CodeRabbit