docs: apply quick fixes to the "getting started" and "demos" page by tbouffard · Pull Request #654 · maxGraph/maxGraph

tbouffard · 2025-01-30T08:07:05Z

Summary by CodeRabbit

Documentation
- Updated documentation for demo-and-examples.md with clearer source references for examples.
- Revised getting-started.mdx to include Apache 2.0 license information and remove redundant sections.
- Improved text clarity and formatting consistency in documentation files.
- Clarified instructions in the README.md for using TypeScript and JavaScript.

coderabbitai · 2025-01-30T08:07:11Z

Walkthrough

This pull request focuses on updating documentation files for the maxGraph project. The changes involve refining the content in three markdown files: demo-and-examples.md, getting-started.mdx, and README.md. The modifications aim to improve clarity, add licensing information, and update repository references. The updates primarily involve textual adjustments and providing more precise information about the project's resources and licensing.

Changes

File	Change Summary
`packages/website/docs/demo-and-examples.md`	- Updated source of examples to specify `maxGraph` GitHub organization - Added direct link to GitHub organization - Minor grammatical improvement in repository description
`packages/website/docs/getting-started.mdx`	- Added Apache 2.0 license information - Removed "Obtaining `maxGraph`" section - Added links to license and GitHub repository - Improved formatting of technology names (TypeScript, JavaScript)
`README.md`	- Clarified instructions for using TypeScript and JavaScript in the "Getting Started" section

Possibly related PRs

docs: add a page to highlight demo and examples #602: The changes in demo-and-examples.md enhance the documentation by providing a structured overview of demos and examples related to maxGraph, which aligns with the main PR's updates to improve clarity and specificity in documentation.
docs: fix link to getting-started page #606: The modification in demo-and-examples.md to fix the link to the "Getting started" page is directly related to the main PR's focus on improving documentation clarity and accuracy.
docs: highlight the getting started page #625: The updates to the getting-started page and its visibility improvements are relevant as they complement the main PR's changes aimed at enhancing documentation clarity and user guidance.

📜 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 66f8cf6 and 2938bec.

📒 Files selected for processing (2)

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

🔇 Additional comments (4)

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

11-11: LGTM! Grammar issues have been fixed.

The licensing information is now grammatically correct and clear.

15-15: LGTM! Text change improves clarity.

The change from "on" to "in" when referring to the GitHub releases page is more idiomatic.

55-55: LGTM! Clear instruction about TypeScript/JavaScript usage.

The instruction about TypeScript and JavaScript usage is clear and helpful for users of both languages.

README.md (1)

72-72: LGTM! Consistent documentation across files.

The TypeScript/JavaScript usage instruction is clear and maintains consistency with the getting-started.mdx file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
@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/getting-started.mdx (1)
55-55: Improve phrasing to avoid repetition.

The current phrasing repeats "want to use". Consider rephrasing for better readability.

Apply this diff to improve the phrasing:
-you want to use `TypeScript`, adapt it if you want to use `JavaScript` (mainly, remove references to the 'type' syntax).
+you're using `TypeScript`. For `JavaScript`, simply remove references to the 'type' syntax.
🧰 Tools

🪛 LanguageTool

[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nt to use TypeScript, adapt it if you want to use JavaScript (mainly, remove refere...

(REP_WANT_TO_VB)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 57a8e1e and 66f8cf6.

📒 Files selected for processing (2)

packages/website/docs/demo-and-examples.md (2 hunks)
packages/website/docs/getting-started.mdx (2 hunks)

🧰 Additional context used

🪛 LanguageTool

packages/website/docs/getting-started.mdx

[uncategorized] ~11-~11: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e.org/licenses/LICENSE-2.0.html) license and it sources are available in the [maxGra...

(COMMA_COMPOUND_SENTENCE)

[misspelling] ~11-~11: Did you mean the possessive “its”?
Context: .../licenses/LICENSE-2.0.html) license and it sources are available in the [maxGraph ...

(LACK_OF_IT_ITS_VBZ_ARE)

[style] ~55-~55: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nt to use TypeScript, adapt it if you want to use JavaScript (mainly, remove refere...

(REP_WANT_TO_VB)

🔇 Additional comments (2)

packages/website/docs/demo-and-examples.md (1)

13-13: LGTM! Documentation improvements enhance clarity.

The changes improve the documentation by:

Adding a direct link to the GitHub organization

Simplifying the description of the integration examples repository

Also applies to: 36-36

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

15-15: LGTM! Improved phrasing.

The change from "on" to "in" improves readability.

packages/website/docs/getting-started.mdx

sonarqubecloud · 2025-01-30T09:05:51Z

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 added 4 commits January 30, 2025 08:14

docs: improve the "getting started" page

9715854

add link to the apache 2.0 license

6fc45c5

improve example introduction

1433584

Update demo-and-examples.md

35e18a1

tbouffard added the documentation Improvements or additions to documentation label Jan 30, 2025

Update demo-and-examples.md

66f8cf6

tbouffard marked this pull request as ready for review January 30, 2025 08:07

coderabbitai bot reviewed Jan 30, 2025

View reviewed changes

packages/website/docs/getting-started.mdx Outdated Show resolved Hide resolved

tbouffard added 2 commits January 30, 2025 10:04

improve wording based on coderabbitai feedback

656a2fb

Merge branch 'main' into docs/improve_getting-started

2938bec

tbouffard changed the title ~~docs: apply quick fixes to the "getting started" and demos page~~ docs: apply quick fixes to the "getting started" and "demos" page Jan 30, 2025

tbouffard merged commit 8831348 into main Jan 30, 2025
3 checks passed

tbouffard deleted the docs/improve_getting-started branch January 30, 2025 09:15

coderabbitai bot mentioned this pull request May 8, 2025

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

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: apply quick fixes to the "getting started" and "demos" page#654

docs: apply quick fixes to the "getting started" and "demos" page#654
tbouffard merged 7 commits intomainfrom
docs/improve_getting-started

tbouffard commented Jan 30, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 30, 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!

sonarqubecloud bot commented Jan 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

tbouffard commented Jan 30, 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 Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

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!

sonarqubecloud bot commented Jan 30, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tbouffard commented Jan 30, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)