Skip to content

docs: add links to specific examples and demos in various pages#603

Merged
tbouffard merged 1 commit intomainfrom
docs/add_links_to_story_in_some_pages
Dec 18, 2024
Merged

docs: add links to specific examples and demos in various pages#603
tbouffard merged 1 commit intomainfrom
docs/add_links_to_story_in_some_pages

Conversation

@tbouffard
Copy link
Copy Markdown
Member

@tbouffard tbouffard commented Dec 18, 2024

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

  • Documentation
    • Updated the CSS and images documentation with a new tip for viewing a TypeScript example.
    • Enhanced the perimeters documentation with additional information, examples, and links to live demos and source code.

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.
@tbouffard tbouffard added the documentation Improvements or additions to documentation label Dec 18, 2024
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Dec 18, 2024

Walkthrough

This pull request focuses on enhancing the documentation for the maxGraph library by updating two markdown files: css-and-images.md and perimeters.md. The changes involve adding more detailed guidance, practical examples, and links to live demos and source code. The updates aim to improve the clarity and usability of the documentation for developers working with the library, providing more context and practical insights into CSS integration, image handling, and perimeter implementations.

Changes

File Change Summary
packages/website/docs/usage/css-and-images.md Added a new section with a tip about viewing a TypeScript example for CSS integration, retaining existing content about CSS rules and image path configuration
packages/website/docs/usage/perimeters.md Added a new note section with links to live demos and source code for perimeter implementations, introduced an "Example of custom behavior" section demonstrating perimeter alignment with vertex label bounds

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 e0f54ed and 4c25c28.

📒 Files selected for processing (2)
  • packages/website/docs/usage/css-and-images.md (1 hunks)
  • packages/website/docs/usage/perimeters.md (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/website/docs/usage/css-and-images.md
🔇 Additional comments (2)
packages/website/docs/usage/perimeters.md (2)

29-33: LGTM! Excellent addition of contextual references

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.


109-113: LGTM! Valuable practical example addition

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 successful

Links 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 executed

The 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?

❤️ 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.

@tbouffard tbouffard merged commit c1d85f3 into main Dec 18, 2024
@tbouffard tbouffard deleted the docs/add_links_to_story_in_some_pages branch December 18, 2024 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant