-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Conversation
* 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 ...
WalkthroughThe pull request introduces a new "Key Contributors" section in the Sylius documentation, specifically modifying the Changes
Suggested reviewers
Possibly related PRs
Poem
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 (
|
There was a problem hiding this 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 formattingThe 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)),  -* 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)). +* 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
📒 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 documentationThe 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)
# Key Contributors | ||
|
||
### Introduction | ||
|
There was a problem hiding this comment.
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.
# 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)
Bunnyshell Preview Environment deletedAvailable commands:
|
Automated changes by create-pull-request GitHub action