docs: mention examples in the documentation introduction #585
Conversation
WalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Examples
User->>Documentation: Access documentation
Documentation->>User: Display "Quick Start" section
User->>Examples: Click on example links
Examples->>User: Show examples and demo
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
🧹 Outside diff range and nitpick comments (2)
packages/website/docs/intro.md (2)
54-63: Great addition that addresses the documentation feedback!The new tip section effectively addresses the feedback about examples and provides multiple helpful resources. The content is well-structured and valuable for newcomers.
Consider enhancing the URL presentation on line 59 with more descriptive link text:
-- Source code for the stories is available at https://github.com/maxGraph/maxGraph/blob/main/packages/html/stories +- Source code for the stories is available in the [examples directory](https://github.com/maxGraph/maxGraph/blob/main/packages/html/stories)🧰 Tools
🪛 Markdownlint (0.35.0)
59-59: null
Bare URL used(MD034, no-bare-urls)
59-59: Fix Markdown linting issue: Convert bare URL to proper link formatThe bare URL triggers the MD034 (no-bare-urls) rule. Using proper Markdown link syntax improves readability and follows Markdown best practices.
Apply this change:
-- Source code for the stories is available at https://github.com/maxGraph/maxGraph/blob/main/packages/html/stories +- Source code for the stories is available at [https://github.com/maxGraph/maxGraph/blob/main/packages/html/stories](https://github.com/maxGraph/maxGraph/blob/main/packages/html/stories)🧰 Tools
🪛 Markdownlint (0.35.0)
59-59: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
packages/website/docs/intro.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
packages/website/docs/intro.md
59-59: null
Bare URL used
(MD034, no-bare-urls)
Notes
Try to prevent newcomers from getting an impression as in #584
Summary by CodeRabbit
maxGraphlibrary with a new "Quick Start" section, highlighting available examples and providing links to a live demo and source code.