Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing a link in docs #8268

Merged
merged 1 commit into from
Aug 9, 2024
Merged

Fixing a link in docs #8268

merged 1 commit into from
Aug 9, 2024

Conversation

Eldies
Copy link
Contributor

@Eldies Eldies commented Aug 6, 2024

Motivation and context

https://docs.cvat.ai/docs/manual/advanced/formats/format-smask/ has a link to pascal voc format page, which is broken.

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Documentation
    • Updated hyperlink formatting for improved clarity and accessibility in the "format-smask" documentation.

Copy link
Contributor

coderabbitai bot commented Aug 6, 2024

Walkthrough

The recent changes primarily involve updates to hyperlink formatting within documentation. Specifically, the link to the "Pascal VOC" documentation was converted from a relative format to an absolute format, improving clarity and accessibility. No changes were made to the overall content or structure of the document, ensuring that the logical flow and functionality remain intact.

Changes

File Path Change Summary
site/content/en/docs/manual/advanced/formats/... Updated hyperlink for "Pascal VOC" from relative to absolute format.

Poem

🐇 In fields of code where hyperlinks roam,
A change was made to guide you home.
From relative paths to absolute skies,
Clarity blooms as the document flies.
So hop along, dear friend, don’t delay,
For smoother links brighten the day! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

sonarcloud bot commented Aug 6, 2024

@Eldies Eldies marked this pull request as ready for review August 7, 2024 05:30
@Eldies Eldies requested a review from mdacoca as a code owner August 7, 2024 05:30
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6e30164 and e83fea8.

Files selected for processing (1)
  • site/content/en/docs/manual/advanced/formats/format-smask.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • site/content/en/docs/manual/advanced/formats/format-smask.md

@nmanovic nmanovic merged commit a9d250d into develop Aug 9, 2024
15 checks passed
@nmanovic nmanovic deleted the dl/fix-docs-link branch August 9, 2024 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants