FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: highlight the getting started page by tbouffard · Pull Request #625 · maxGraph/maxGraph · GitHub

/ maxGraph Public
forked from jgraph/mxgraph

docs: highlight the getting started page - #625

Merged
tbouffard merged 2 commits into
mainfrom
docs/highlight_getting_started
Jan 8, 2025
ConversationCommits (2)ChecksFiles changed
Merged

docs: highlight the getting started page#625
tbouffard merged 2 commits into
mainfrom
docs/highlight_getting_started

Conversation

tbouffard commented Jan 7, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Previously, the start page was located in the “manual” folder and was therefore not very visible.
This page is the first point of entry for newcomers and therefore needs to be more visible.
It has now been moved to 2nd position in the menu to give it greater prominence.

The introduction page has also been updated to link to the documentation rather than to the repository README.

Notes

Covers #345

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated README.md with improved content organization and image path references.
    • Enhanced demo-and-examples.md with a new tip section clarifying documentation scope.
    • Refined getting-started.mdx by removing work-in-progress warning and adding a licensing note.
    • Simplified intro.md with more direct guidance to the Getting Started guide.
    • Added a new URL redirect for improved navigation.

  • Chores

    • Streamlined documentation structure and content across multiple files.

docs: highlight the getting started page
2bbd598 
Previously, the start page was located in the “manual” folder and was therefore not very visible.
This page is the first point of entry for newcomers and therefore needs to be more visible.
It has now been moved to 2nd position in the menu to give it greater prominence.

The introduction page has also been updated to link to the documentation rather than to the repository README.
tbouffard added the documentation Improvements or additions to documentation label Jan 7, 2025

coderabbitai Bot commented Jan 7, 2025 •
edited
Loading

Copy link
Copy Markdown

Walkthrough

This pull request focuses on reorganizing and updating documentation for the maxGraph library. The changes primarily involve restructuring documentation paths, updating references from a manual directory to a getting-started directory, and making minor content improvements. A new redirect rule is added to ensure smooth navigation for users accessing older documentation URLs.

Changes

File Change Summary
README.md Updated content location references and image path
packages/website/docs/demo-and-examples.md Modified sidebar position and added a tip section about documentation examples
packages/website/docs/getting-started.mdx Removed work-in-progress warning, added licensing note, and inserted a new styling image
packages/website/docs/intro.md Simplified "Quick Start" section and removed additional feature exploration content
packages/website/docusaurus.config.ts Added redirect rule from /docs/manual/getting-started to /docs/getting-started

Possibly related PRs

📜 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 2bbd598 and 4502e37.

📒 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

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 Bot reviewed Jan 7, 2025
View reviewed changes

coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/website/docs/intro.md (1)

37-37: Consider using more common American English phrasing.

Replace "have a look at" with "take a look at" for better consistency with American English usage.

-To know how to install maxGraph and how to implement a first example, have a look at the [Getting Started](./getting-started.mdx) guide.
+To know how to install maxGraph and how to implement a first example, take a look at the [Getting Started](./getting-started.mdx) guide.
🧰 Tools 🪛 LanguageTool

[locale-violation] ~37-~37: In American English, “take a look” is more commonly used.
Context: ...h and how to implement a first example, have a look at the [Getting Started](./getting-star...

(HAVE_A_LOOK)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e76b595 and 2bbd598.

⛔ Files ignored due to path filters (2)
  • packages/website/docs/assets/getting-started/first-graph.gif is excluded by !**/*.gif
  • packages/website/docs/assets/getting-started/vertex-style.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • README.md (4 hunks)
  • packages/website/docs/demo-and-examples.md (1 hunks)
  • packages/website/docs/getting-started.mdx (1 hunks)
  • packages/website/docs/intro.md (1 hunks)
  • packages/website/docusaurus.config.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • README.md
🧰 Additional context used 🪛 LanguageTool packages/website/docs/intro.md

[locale-violation] ~37-~37: In American English, “take a look” is more commonly used.
Context: ...h and how to implement a first example, have a look at the [Getting Started](./getting-star...

(HAVE_A_LOOK)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build
🔇 Additional comments (3)
packages/website/docusaurus.config.ts (1)

169-173: LGTM! Redirect configuration properly handles documentation restructuring.

The new redirect rule ensures users accessing the old URL path will be seamlessly redirected to the new location, maintaining backward compatibility.

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

9-15: LGTM! Clear expectations set about documentation coverage.

The new tip section effectively communicates the scope of documentation and directs users to examples, improving the overall user experience.

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

219-219: LGTM! Visual example enhances the documentation.

The addition of the vertex styling image provides a clear visual reference that complements the code example.

tbouffard commented Jan 7, 2025

Copy link
Copy Markdown
Member Author

@coderabbitai review

coderabbitai Bot commented Jan 7, 2025

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

tbouffard commented Jan 7, 2025

Copy link
Copy Markdown
Member Author

@coderabbitai review

coderabbitai Bot commented Jan 7, 2025

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

tbouffard merged commit 0a51982 into main Jan 8, 2025
tbouffard deleted the docs/highlight_getting_started branch January 8, 2025 08:51
coderabbitai Bot mentioned this pull request Jan 8, 2025
Merged
This was referenced Jan 29, 2025
Merged
Merged
Merged
coderabbitai Bot mentioned this pull request Feb 19, 2026
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Back | FazBrowse Home | New Git URL