iframe-proxy

tbouffard · 2025-04-29T16:13:18Z

Improve the Introduction section with better formatting and clearer presentation of the npm package content.
Add a new "Documentation Structure" section that outlines the organization of documentation.

Summary by CodeRabbit

Documentation
- Expanded and clarified TypeScript support and compatibility details in the installation instructions.
- Added an informational note about TypeScript integration and ES2020/ES Module requirements.
- Introduced a new "Documentation Structure" section outlining the organization of the documentation for easier navigation.

Improve the Introduction section with better formatting and clearer presentation of the npm package content. Add a new "Documentation Structure" section that outlines the organization of documentation.

coderabbitai · 2025-04-29T16:13:25Z

Walkthrough

The documentation for the maxGraph project was updated to improve clarity and organization. Information about TypeScript support and ES Module compatibility was expanded and repositioned within both the main README and the website's installation guide. Additionally, the introductory documentation was restructured to include a new "Documentation Structure" section, providing a clearer overview of the documentation's organization. No changes were made to the codebase or exported/public entities.

Changes

File(s)	Change Summary
README.md, packages/website/docs/getting-started.mdx	Expanded and relocated TypeScript and ES Module compatibility notes to installation sections; improved wording.
packages/website/docs/intro.md	Added a new "Documentation Structure" section, reorganized the introduction, and clarified documentation layout.

Sequence Diagram(s)

No sequence diagrams are generated as the changes are limited to documentation updates and do not affect control flow or introduce new features.

Possibly related PRs

docs: mention examples in the documentation introduction #585: Added a tip about examples under the existing "Quick Start" section in intro.md, complementing the restructuring and expansion of the introduction in this PR.

📜 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 bf32fb0 and 12afe21.

📒 Files selected for processing (1)

packages/website/docs/intro.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/website/docs/intro.md

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

Actionable comments posted: 1

🧹 Nitpick comments (1)

packages/website/docs/intro.md (1)
37-41: Enhance Navigation by Linkifying Section Entries
To mirror the linked Manual entry, consider hyperlinking the other bullets. For example:
- **Tutorials**
+ **[Tutorials](./tutorials/index.md)**
- **Usage**
+ **[Usage](./usage/index.md)**
- **Development**
+ **[Development](./development/index.md)**
This will allow readers to jump directly to each section.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 447862e and bf32fb0.

📒 Files selected for processing (3)

README.md (1 hunks)
packages/website/docs/getting-started.mdx (1 hunks)
packages/website/docs/intro.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build

🔇 Additional comments (2)

packages/website/docs/getting-started.mdx (1)

39-45: Well-structured TypeScript Compatibility Admonition
The new :::info block effectively conveys that maxGraph is authored in TypeScript, the ES2020/ESM target, and the TS ≥3.8 requirement. It matches the style conventions used elsewhere and improves clarity for developers.

README.md (1)

61-67: Relocated and Clarified TypeScript Support Section
The insertion clearly highlights TypeScript definitions, ES2020 output, and module format directly under the “Install” heading, which enhances discoverability and consistency with the website docs.

sonarqubecloud · 2025-04-30T04:44:32Z

docs: add structure section and improve npm package details

bf32fb0

Improve the Introduction section with better formatting and clearer presentation of the npm package content. Add a new "Documentation Structure" section that outlines the organization of documentation.

tbouffard added the documentation Improvements or additions to documentation label Apr 29, 2025

coderabbitai Bot reviewed Apr 29, 2025

View reviewed changes

Comment thread packages/website/docs/intro.md Outdated

tbouffard added 2 commits April 30, 2025 06:42

Add links to categories of the documentation

91b3d7c

intro: fix header level

12afe21

tbouffard commented Apr 30, 2025

View reviewed changes

Comment thread packages/website/docs/intro.md Outdated

Comment thread packages/website/docs/intro.md Outdated

tbouffard merged commit 8e7ef1a into main Apr 30, 2025

tbouffard deleted the docs/improve_presentation branch April 30, 2025 04:45

coderabbitai Bot mentioned this pull request May 7, 2025

docs: enhance demo homepage with emojis and better organization #820

Merged

coderabbitai Bot mentioned this pull request Nov 14, 2025

docs: add Contributing guide #948

Merged

coderabbitai Bot mentioned this pull request Feb 18, 2026

docs: improve library presentation in README and website #1006

Merged

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add structure section and improve npm package details#792

docs: add structure section and improve npm package details#792
tbouffard merged 3 commits into
mainfrom
docs/improve_presentation

tbouffard commented Apr 29, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 29, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Conversation

tbouffard commented Apr 29, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 30, 2025

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tbouffard commented Apr 29, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)