docs: add links to specific examples and demos in various pages#603
docs: add links to specific examples and demos in various pages#603
Conversation
The purpose is to better guide readers to examples of code that actually uses the concept explained in the documentation. This is done for now in the "css and images" and "perimeters" pages.
WalkthroughThis pull request focuses on enhancing the documentation for the Changes
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🔇 Additional comments (2)packages/website/docs/usage/perimeters.md (2)
The note block effectively connects the visual example to its implementation, making it easier for users to explore and understand the code behind the demonstration.
The new section about custom behavior provides a concrete use case with corresponding demo and source code, which aligns perfectly with the documentation enhancement goals. Let's verify the link validity: ✅ Verification successfulLinks are valid and accessible Both the demo and source code URLs return HTTP 200 status codes, confirming they are accessible and working as expected. The documentation accurately references existing resources. 🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Description: Verify that the demo and source code links are accessible
# Expected: Both URLs should return successful status codes
# Check the demo URL
curl -s -o /dev/null -w "%{http_code}" "https://maxgraph.github.io/maxGraph/demo/?path=/story/labels-perimeteronlabelbounds--default"
# Check the source code URL
curl -s -o /dev/null -w "%{http_code}" "https://github.com/maxGraph/maxGraph/blob/main/packages/html/stories/PerimeterOnLabelBounds.stories.ts"
Length of output: 286 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 (
|
The purpose is to better guide readers to examples of code that actually uses the concept explained in the documentation.
This is done for now in the "css and images" and "perimeters" pages.
Summary by CodeRabbit