Improve readme adding quick start, github action and an improved introduction #557
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #557 +/- ##
=========================================
Coverage 97.76% 97.76%
Complexity 619 619
=========================================
Files 79 79
Lines 1788 1788
=========================================
Hits 1748 1748
Misses 40 40 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
**Introduction improvements:** - Add clear definition of what PHPArkitect does - Add "Why PHPArkitect?" section explaining key benefits - Include multiple code examples showing common use cases - Make the value proposition immediately clear **Quick Start section:** - Add 3-step quick start guide for new users - Include minimal working configuration example - Provide clear next steps after setup - Move quick start before detailed installation options This makes the README more approachable for newcomers while keeping all detailed information accessible.
Add official GitHub Action integration documentation to help users easily set up PHPArkitect in their CI/CD pipelines. - Include complete workflow example - Add links to GitHub Action repository and Marketplace - Position before Laravel integration for better visibility - Provide configuration examples for PHP version and Arkitect version This makes it easier for teams to enforce architectural rules in their pull request workflows.
Corrected the GitHub Action usage example to use the actual documented parameters: - Use docker://phparkitect/arkitect-github-actions instead of @v1 - Use PHP_VERSION as environment variable (not input parameter) - Use 'args: check' instead of incorrect php_version/arkitect_version - Update description to reflect actual capabilities Thanks to user feedback for catching this error.
Remove inline YAML example and instead reference the official GitHub Action repository for setup instructions. This prevents documentation drift and ensures users always get the most up-to-date configuration examples from the authoritative source.
fain182
force-pushed
the
claude/improve-intro-quickstart-kMctv
branch
from
31b75fa to
bd507f9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.