Skip to content

[Docs] Fix links to new Sylius 2 documentation in README#17676

Merged
GSadee merged 1 commit intoSylius:2.0from
stlgaits:docs-readme-links
Feb 25, 2025
Merged

[Docs] Fix links to new Sylius 2 documentation in README#17676
GSadee merged 1 commit intoSylius:2.0from
stlgaits:docs-readme-links

Conversation

@stlgaits
Copy link
Copy Markdown
Contributor

@stlgaits stlgaits commented Feb 14, 2025 •
edited by coderabbitai bot
Loading

Q A
Branch? 2.1
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no

Links in README file were pointing to the old documentation.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links for installation, system requirements, tutorials, and contribution guidelines.

@stlgaits stlgaits requested review from a team as code owners February 14, 2025 17:27
@probot-autolabeler probot-autolabeler bot added the Maintenance CI configurations, READMEs, releases, etc. label Feb 14, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 14, 2025 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request updates the README.md file by revising several URL references. The modifications include changes to the installation, requirements, tutorial, and contributing guide links. The changes ensure that the documentation points to current paths without altering the overall structure or functionality of the file.

Changes

File(s) Change Summary
README.md Updated URLs: revised installation, requirements, tutorial, and contributing guide links.

Suggested labels

Documentation

Suggested reviewers

  • GSadee

Poem

I'm a rabbit with a hop and a beat,
Updating docs to make them neat.
New URLs leap into brighter days,
In README fields where clarity stays.
Carrots and code, a change so sweet!
🥕🐰 Hop along, let your joy repeat!

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.

@GSadee GSadee changed the base branch from 2.1 to 2.0 February 25, 2025 13:04
@GSadee
Copy link
Copy Markdown
Member

GSadee commented Feb 25, 2025

The base of this pull-request was changed, you need fetch and reset your local branch
if you want to add new commits to this pull request. Reset before you pull, else commits
may become messed-up.

Unless you added new commits (to this branch) locally that you did not push yet,
execute git fetch origin && git reset "docs-readme-links" to update your local branch.

Feel free to ask for assistance when you get stuck 👍

@GSadee GSadee added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label Feb 25, 2025
@GSadee GSadee merged commit 0d31337 into Sylius:2.0 Feb 25, 2025
3 checks passed
@GSadee
Copy link
Copy Markdown
Member

GSadee commented Feb 25, 2025

Thank you @stlgaits! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GSadee GSadee GSadee approved these changes

Assignees

No one assigned

Labels

Documentation Documentation related issues and PRs - requests, fixes, proposals. Maintenance CI configurations, READMEs, releases, etc.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@stlgaits @GSadee