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

[DOCUMENTATION] Synchronize 2.0-docs -> 2.0 #17622

Merged
merged 2 commits into from
Jan 13, 2025
Merged

[DOCUMENTATION] Synchronize 2.0-docs -> 2.0 #17622

merged 2 commits into from
Jan 13, 2025

Conversation

SyliusBot
Copy link

@SyliusBot SyliusBot commented Jan 11, 2025

Automated changes by create-pull-request GitHub action

GSadee and others added 2 commits January 10, 2025 11:06
* 2.0: (52 commits)
  Fix availability checker aliases
  Add help on channel pricing when product is simple
  [Maintenance][OrderProcessing] Extract adjustment types to be cleared to a parameter
  Add hooks for channel_pricing accordion
  Remove semantic classes
  Implement twig hooks for product variant
  Revert skipped phpunit test
  [Bug] Fix missing variable
  [CS][DX] Refactor
  make service public
  [CS][DX] Refactor
  [CS][DX] Refactor
  Resolve conflicts
  Minor changes after CR
  Fix Doctrine ORM bug
  [Bug] Fix statistics tests in new year
  [Maintenance] New migrations skipping logic cleanup and testing
  Improve handling of migrations with custom migration table name in a generic way
  fix: migration fails when migrations have a custom table name
  Minor changes after CR
  ...
@SyliusBot SyliusBot requested review from a team as code owners January 11, 2025 03:06
@probot-autolabeler probot-autolabeler bot added Documentation Documentation related issues and PRs - requests, fixes, proposals. Maintenance CI configurations, READMEs, releases, etc. labels Jan 11, 2025
Copy link

coderabbitai bot commented Jan 11, 2025

Walkthrough

The pull request introduces a new "Key Contributors" section in the Sylius documentation, specifically modifying the docs/SUMMARY.md file and creating a new markdown file docs/the-book/contributing/key-contributors.md. The changes involve correcting a URL formatting issue in the existing table of contents and adding a comprehensive document that outlines the Sylius Key Contributors program, its criteria, benefits, and current contributors.

Changes

File Change Summary
docs/SUMMARY.md - Corrected URL formatting for "Sylius Roadmap" link
- Added new "Key Contributors" entry under Contributing section
docs/the-book/contributing/key-contributors.md - Created new document detailing Key Contributors program
- Described program criteria, benefits, and current contributors

Suggested reviewers

  • GSadee

Possibly related PRs

Poem

🐰 Hop into the world of code, my friend
Where contributors rise and legends ascend
Key Contributors, a badge of pride
Open source spirit, taking us for a ride!
Sylius grows stronger, one commit at a time 🚀


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.

Copy link

@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: 1

🧹 Nitpick comments (1)
docs/the-book/contributing/key-contributors.md (1)

45-51: Clean up contributors list formatting

The list formatting can be simplified and made more consistent.

Apply this diff to improve the formatting:

-* Loïc Frémont (@[loic425](https://github.com/loic425)),&#x20;
-* Francis Hilaire (@[Prometee](https://github.com/Prometee)),&#x20;
-* Dmitri Perunov (@[diimpp](https://github.com/diimpp)),&#x20;
-* Gracjan Józefczyk (@[GracjanJozefczyk](https://github.com/GracjanJozefczyk)),&#x20;
-* Valentin Silvestre (@[vasilvestre](https://github.com/vasilvestre)),&#x20;
-* Krzysztof Odważny (@[christopherhero](https://github.com/christopherhero)),
-* Stephane Decock (@[Roshyo](https://github.com/Roshyo)).
+* Loïc Frémont (@[loic425](https://github.com/loic425))
+* Francis Hilaire (@[Prometee](https://github.com/Prometee))
+* Dmitri Perunov (@[diimpp](https://github.com/diimpp))
+* Gracjan Józefczyk (@[GracjanJozefczyk](https://github.com/GracjanJozefczyk))
+* Valentin Silvestre (@[vasilvestre](https://github.com/vasilvestre))
+* Krzysztof Odważny (@[christopherhero](https://github.com/christopherhero))
+* Stephane Decock (@[Roshyo](https://github.com/Roshyo))
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9e7f1bf and 9715ed1.

📒 Files selected for processing (2)
  • docs/SUMMARY.md (2 hunks)
  • docs/the-book/contributing/key-contributors.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/SUMMARY.md
🧰 Additional context used
🪛 LanguageTool
docs/the-book/contributing/key-contributors.md

[style] ~61-~61: Opting for a less wordy alternative here can improve the clarity of your writing.
Context: ... that endorse open-source contributions not only strengthen Sylius but also demonstrate leadership in the tech industry. To lea...

(NOT_ONLY_ALSO)

🪛 Markdownlint (0.37.0)
docs/the-book/contributing/key-contributors.md

3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Static checks / PHP 8.3, Symfony ^7.1
  • GitHub Check: Static checks / PHP 8.2, Symfony ^6.4
🔇 Additional comments (1)
docs/the-book/contributing/key-contributors.md (1)

5-81: Well-structured and comprehensive documentation

The content effectively communicates the Key Contributors program's purpose, benefits, qualifications, and processes. The structure is logical and the information is clear and complete.

🧰 Tools
🪛 LanguageTool

[style] ~61-~61: Opting for a less wordy alternative here can improve the clarity of your writing.
Context: ... that endorse open-source contributions not only strengthen Sylius but also demonstrate leadership in the tech industry. To lea...

(NOT_ONLY_ALSO)

Comment on lines +1 to +4
# Key Contributors

### Introduction

Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix heading hierarchy

The document's heading structure should follow a logical hierarchy, incrementing by only one level at a time.

Apply this diff to fix the heading structure:

 # Key Contributors

-### Introduction
+## Introduction
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Key Contributors
### Introduction
# Key Contributors
## Introduction
🧰 Tools
🪛 Markdownlint (0.37.0)

3-3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)

Copy link

github-actions bot commented Jan 11, 2025

Bunnyshell Preview Environment deleted

Available commands:

  • /bns:deploy to redeploy the environment

@GSadee GSadee merged commit 122b10f into 2.0 Jan 13, 2025
48 of 51 checks passed
@GSadee GSadee deleted the docs/2.0-docs_2.0 branch January 13, 2025 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals. Maintenance CI configurations, READMEs, releases, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants