docs: add graph documentation page and refine related pages by redfish4ktc · Pull Request #1048 · maxGraph/maxGraph

redfish4ktc · 2026-04-15T15:59:39Z

Add new "Graph" page covering AbstractGraph, Graph, BaseGraph, comparison and use cases
Add cross-references to the new page across usage, manual and tutorials docs
Refine plugins.md: alphabetized table, emoji status column, BaseGraph examples, warning against duplicate plugins, improved intro of "Choosing the Plugins to Use", removed reference to default plugins
Fix typo in website README

Notes

Covers #781

Tasks

Once refactor!: convert ImageMixin to ImageBundlePlugin #1050 is merged, update the ImageBundle page to link the "graph" page
Rework the "plugins" page: it includes "Choosing the Plugins to Use" which may duplicate what we now have in the graph page.

Summary by CodeRabbit

Documentation
- Clarified Graph vs BaseGraph behavior (defaults, auto-registration, plugins, styles, perimeters, edge styles) and added a comprehensive Graph hierarchy/usage page with improved cross-references across tutorials and guides.
- Expanded plugin, image-bundle, i18n, CSS/image, and example guidance; refined multiple tutorial and manual wordings; README note about local dev server/navbar links.
Chores
- Reorganized documentation structure.

coderabbitai · 2026-04-15T15:59:49Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e1dce059-c7ea-42b3-90ae-eaf70c318bcf

📥 Commits

Reviewing files that changed from the base of the PR and between 0fd946a and 2fefb41.

📒 Files selected for processing (1)

packages/website/docs/usage/graph.md

✅ Files skipped from review due to trivial changes (1)

packages/website/docs/usage/graph.md

Walkthrough

This PR adds JSDoc and inline comments to AbstractGraph/Graph, introduces a comprehensive Graph hierarchy guide (graph.md), and updates many website docs to link to and clarify differences between Graph and BaseGraph (auto-registration, plugins, constructor patterns, and related wording).

Changes

Graph and BaseGraph Documentation and Integration

Layer / File(s)	Summary
Core source code documentation improvements `packages/core/src/view/AbstractGraph.ts`, `packages/core/src/view/Graph.ts`	JSDoc and inline comments document `initializeCollaborators()` wiring requirements for subclasses and clarify how `Graph` builds components via factory methods with positional constructor options.
Comprehensive Graph hierarchy documentation `packages/website/docs/usage/graph.md`	New page explains the class hierarchy (AbstractGraph → Graph/BaseGraph), lifecycle hooks, auto-registration behavior, plugin defaults, constructor differences, and provides TypeScript examples for both Graph (batteries-included) and BaseGraph (minimal/opt-in) patterns.
Documentation cross-linking and Graph/BaseGraph clarifications `packages/website/README.md`, `packages/website/docs/development/high-level-api-description.md`, `packages/website/docs/intro.md`, `packages/website/docs/tutorials/graph.md`, `packages/website/docs/tutorials/the-hello-world-example.md`, `packages/website/docs/tutorials/editor.md`, `packages/website/docs/manual/cells.md`, `packages/website/docs/manual/group-and-complexity-management.md`, `packages/website/docs/usage/css-and-images.md`, `packages/website/docs/usage/edge-styles.md`, `packages/website/docs/usage/global-configuration.md`, `packages/website/docs/usage/i18n.md`, `packages/website/docs/usage/image-bundles.md`, `packages/website/docs/usage/migrate-from-mxgraph.md`, `packages/website/docs/usage/perimeters.md`, `packages/website/docs/usage/plugins.md`	Update existing docs to link Graph/BaseGraph references to the new hierarchy guide, clarify that style elements and plugins auto-register for `Graph` but require explicit registration for `BaseGraph`, and refine wording in tutorials and guides throughout the site.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

Document usage of BaseGraph and advices for optimal tree-shaking #781: Documentation request about Graph vs BaseGraph and tree-shaking guidance which this PR addresses.

Possibly related PRs

maxGraph/maxGraph#627: Related docs link adjustments in migrate-from-mxgraph.md.
maxGraph/maxGraph#690: Related i18n/resource updates referenced by the i18n docs edits.

Suggested reviewers

tbouffard

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description provides a clear overview of changes but lacks several PR checklist items required by the template (PR checklist checkboxes, discussion with maintainers confirmation, scope confirmation).	Complete the PR checklist section with all required checkboxes marked, and confirm discussion with maintainers and scope assessment as specified in the template.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding a new Graph documentation page and refining related documentation pages.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ 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.}

- Add new "Graph" page covering AbstractGraph, Graph, BaseGraph, comparison and use cases - Add cross-references to the new page across usage, manual and tutorials docs - Refine plugins.md: alphabetized table, emoji status column, BaseGraph examples, warning against duplicate plugins, improved intro of "Choosing the Plugins to Use", removed reference to default plugins - Fix typo in website README

sonarqubecloud · 2026-04-27T14:10:44Z

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

sonarqubecloud · 2026-05-16T06:28:11Z

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

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (1)

packages/website/docs/usage/plugins.md (1)

25-25: ⚡ Quick win

Consider simplifying "a large number of" to "many".

To reduce wordiness, "a large number of handler instances" could be simplified to "many handler instances" or "numerous handler instances".

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 29e0a523-5595-44fe-b571-0e491bf7f31b

📥 Commits

Reviewing files that changed from the base of the PR and between 5f189e7 and 10cf860.

📒 Files selected for processing (19)

packages/core/src/view/AbstractGraph.ts
packages/core/src/view/Graph.ts
packages/website/README.md
packages/website/docs/development/high-level-api-description.md
packages/website/docs/intro.md
packages/website/docs/manual/cells.md
packages/website/docs/manual/group-and-complexity-management.md
packages/website/docs/tutorials/editor.md
packages/website/docs/tutorials/graph.md
packages/website/docs/tutorials/the-hello-world-example.md
packages/website/docs/usage/css-and-images.md
packages/website/docs/usage/edge-styles.md
packages/website/docs/usage/global-configuration.md
packages/website/docs/usage/graph.md
packages/website/docs/usage/i18n.md
packages/website/docs/usage/image-bundles.md
packages/website/docs/usage/migrate-from-mxgraph.md
packages/website/docs/usage/perimeters.md
packages/website/docs/usage/plugins.md

sonarqubecloud · 2026-05-18T09:02:16Z

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

redfish4ktc added the documentation Improvements or additions to documentation label Apr 15, 2026

redfish4ktc mentioned this pull request Apr 15, 2026

Document usage of BaseGraph and advices for optimal tree-shaking #781

Open

2 tasks

tbouffard reviewed Apr 24, 2026

View reviewed changes

Comment thread packages/website/docs/usage/plugins.md Outdated

tbouffard reviewed Apr 24, 2026

View reviewed changes

Comment thread packages/website/docs/usage/plugins.md Outdated

redfish4ktc force-pushed the docs/add_graph_page branch from b354aff to b61394f Compare April 27, 2026 14:09

redfish4ktc changed the title ~~docs: add graph documentation page and update related pages~~ docs: add graph documentation page and refine related pages Apr 28, 2026

Integrate review feedback

10cf860

tbouffard marked this pull request as ready for review May 16, 2026 06:27

coderabbitai Bot reviewed May 16, 2026

View reviewed changes

Comment thread packages/website/docs/development/high-level-api-description.md Outdated

Comment thread packages/website/docs/usage/graph.md Outdated

redfish4ktc added 3 commits May 18, 2026 10:03

review feedback

1ac09e0

Merge branch 'main' into docs/add_graph_page

0fd946a

review feedback

2fefb41

redfish4ktc merged commit 8d744e1 into main May 18, 2026
14 checks passed

redfish4ktc deleted the docs/add_graph_page branch May 18, 2026 09:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add graph documentation page and refine related pages#1048

docs: add graph documentation page and refine related pages#1048
redfish4ktc merged 5 commits into
mainfrom
docs/add_graph_page

redfish4ktc commented Apr 15, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 15, 2026 •

edited

Loading

❌ Failed checks (1 inconclusive)

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 27, 2026

Uh oh!

sonarqubecloud Bot commented May 16, 2026

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 18, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

redfish4ktc commented Apr 15, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes

Tasks

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related issues

Possibly related PRs

Suggested reviewers

❌ Failed checks (1 inconclusive)

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 27, 2026

Quality Gate passed

Uh oh!

sonarqubecloud Bot commented May 16, 2026

Quality Gate passed

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 18, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

redfish4ktc commented Apr 15, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 15, 2026 •

edited

Loading