Skip to content

docs: improve library presentation in README and website#1006

Merged
tbouffard merged 8 commits intomainfrom
docs/improve_lib_presentation
Feb 19, 2026
Merged

docs: improve library presentation in README and website#1006
tbouffard merged 8 commits intomainfrom
docs/improve_lib_presentation

Conversation

@tbouffard
Copy link
Copy Markdown
Member

@tbouffard tbouffard commented Feb 18, 2026 •
edited
Loading

  • 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

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

  • Documentation
    • Revised project documentation with enhanced feature descriptions.
    • Added comprehensive Features sections detailing core capabilities, interactive editing, automatic layouts, data serialization, and developer experience.
    • Modernized documentation narrative emphasizing modern architecture, framework-agnostic design, and diagram application building capabilities.

@tbouffard
docs: improve library presentation in README and website
1a57168 
- 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
@tbouffard tbouffard added the documentation Improvements or additions to documentation label Feb 18, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 18, 2026 •
edited
Loading

Walkthrough

Documentation files updated across the repository to replace initial narratives with feature-focused descriptions. Three README and intro files revised to emphasize maxGraph as an interactive diagram application library with new comprehensive Features sections highlighting architecture, drawing, interaction, layouts, organization, data serialization, and developer experience.

Changes

Cohort / File(s) Summary
Documentation READMEs
README.md, packages/core/README.md, packages/website/docs/intro.md		 Narrative content replaced with feature-focused descriptions. Removed presentation-software-like capability references and added comprehensive Features sections detailing graph model, drawing, interaction, automatic layouts, organization, data/serialization, and TypeScript-native developer experience. Updated mxGraph migration narrative and development status references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description lacks a structured approach required by the template, missing PR checklist completion, issue linkage, scope justification, testing details, documentation references, and conventional commits title verification. Complete the PR checklist sections, explicitly reference the associated issue number (or explain why none exists), confirm scope narrowness, document testing approach, provide screenshot/video evidence where applicable, and verify the PR title follows conventional commits format.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: improve library presentation in README and website' accurately describes the main changes, which involve rewriting documentation and improving how the library is presented across multiple README files and website pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

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

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Feb 18, 2026
View reviewed changes
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 to packages/core/README.md and packages/website/docs/intro.md were 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 -->

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Feb 19, 2026

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 b30ae50 into main Feb 19, 2026
8 checks passed
@tbouffard tbouffard deleted the docs/improve_lib_presentation branch February 19, 2026 13:56
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