docs: highlight the getting started page #625
Conversation
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.
WalkthroughThis pull request focuses on reorganizing and updating documentation for the maxGraph library. The changes primarily involve restructuring documentation paths, updating references from a Changes
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
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
⛔ Files ignored due to path filters (2)
packages/website/docs/assets/getting-started/first-graph.gifis excluded by!**/*.gifpackages/website/docs/assets/getting-started/vertex-style.pngis 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.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
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
Chores