Skip to content

Commit ecfee18

Browse files
committed
docs: update docs
1 parent a75f8de commit ecfee18

18 files changed

+145
-1620
lines changed

docs/FEATURE_PROPOSAL_ADDITIONAL_TOOLS.md

Lines changed: 0 additions & 521 deletions
This file was deleted.

docs/IMPROVEMENT_SUGGESTIONS.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

docs/content/0.index.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,18 @@ secondary:
1919
---
2020

2121
#title
22-
Elevate Your PHP Development
22+
PHP Development Booster
2323

2424
#description
25-
The PHP Booster provides a curated collection of best practices, tools, and resources to empower you to build robust, maintainable, and modern PHP applications.
25+
A curated stack of quality tools for PHP projects: Static Analysis, Formatting, Refactoring, and Git Hooks.
2626

2727
#extra
2828
::list
29-
- Streamlined local development with [Docker](https://www.docker.com/) and [DDEV](https://www.ddev.com/)
30-
- Early bug detection with [PHPStan](https://phpstan.org/) and [Psalm](https://psalm.dev/)
31-
- Consistent code style with [EasyCodingStandard](https://github.com/easy-coding-standard/easy-coding-standard)
32-
- Effortless code modernization with [Rector](https://getrector.org/)
33-
- Automated workflows with Git hooks and [CommitLint](https://commitlint.js.org/)
34-
- Clear API documentation with [Swagger-PHP](https://zircote.github.io/swagger-php/) and [ReDoc](https://github.com/Redocly/redoc)
35-
- And much more...
29+
- **Local Dev**: [DDEV](https://www.ddev.com/) integration
30+
- **Quality**: [PHPStan](https://phpstan.org/), [Psalm](https://psalm.dev/), [ECS](https://github.com/easy-coding-standard/easy-coding-standard)
31+
- **Modernization**: [Rector](https://getrector.org/)
32+
- **Workflow**: Git hooks, [CommitLint](https://commitlint.js.org/)
33+
- **Docs**: [Swagger-PHP](https://zircote.github.io/swagger-php/), [ReDoc](https://github.com/Redocly/redoc)
3634
::
3735
::
3836

docs/content/1.integration_guide/2.interactive_mode.md

Lines changed: 0 additions & 198 deletions
This file was deleted.

docs/content/1.integration_guide/integration_guide.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Quick Start
1+
# Integration Guide
2+
3+
## Quick Start
24

35
Follow these steps to integrate the PHP Development Booster into your existing PHP project:
46

@@ -23,3 +25,24 @@ Follow these steps to integrate the PHP Development Booster into your existing P
2325
git commit -m "Integrate PHP Development Booster"
2426
```
2527
- Push the branch to your repository and create a pull request for review.
28+
29+
## Interactive Mode
30+
31+
The integration script includes an **Interactive Mode** (`-I`) that guides you through the setup process with a wizard. This is useful for customizing the integration (selecting specific tools, configuring ticket IDs, etc.).
32+
33+
### Usage
34+
35+
```bash
36+
curl -sSL https://raw.githubusercontent.com/TerrorSquad/php-booster/main/booster/integrate_booster.sh | bash -s -- -I
37+
```
38+
39+
### Configuration Steps
40+
41+
1. **Select Code Quality Tools**: Choose to install ECS, Rector, PHPStan, or Psalm individually or all at once.
42+
2. **Configure Git Workflow**:
43+
* **Ticket IDs**: Enforce ticket IDs in branch names (e.g., `feature/PRJ-123-description`).
44+
* **Ticket Prefix**: Set your project's prefix (e.g., `PRJ`, `JIRA`).
45+
* **Commit Footer**: Customize the footer label (e.g., `Closes: PRJ-123`).
46+
3. **IDE Configuration**: Optionally install settings for VS Code, PhpStorm, and EditorConfig.
47+
48+
The wizard will display a summary of your choices before applying any changes.

docs/content/3.tools/1.code_formatting.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,7 @@ layout: default
66

77
# Code Formatting
88

9-
## Introduction
10-
11-
Maintaining a consistent code style across your PHP project is crucial for readability, maintainability, and collaboration. [EasyCodingStandard (ECS)](https://github.com/easy-coding-standard/easy-coding-standard) is a powerful tool that automates code formatting and helps enforce coding standards, ensuring your codebase remains clean and well-organized.
12-
13-
## Why EasyCodingStandard?
14-
15-
ECS offers several key benefits for PHP developers:
16-
17-
* **Automated Formatting:** ECS automatically formats your code according to predefined rules, saving you time and effort.
18-
* **Customizable Rules:** You have fine-grained control over the coding standards you want to enforce, allowing you to tailor ECS to your project's specific needs.
19-
* **IDE Integration:** ECS integrates seamlessly with popular IDEs, providing real-time feedback and automatic fixes as you code.
20-
* **Git Hooks Integration:** You can easily integrate ECS into your Git hooks to ensure that only properly formatted code is committed.
9+
We use [EasyCodingStandard (ECS)](https://github.com/easy-coding-standard/easy-coding-standard) to enforce consistent code style and formatting.
2110

2211
## Usage
2312

@@ -42,11 +31,7 @@ ddev composer fix-cs
4231
## Configuration
4332
4433
The `ecs.php` file in your project root is where you configure EasyCodingStandard. This file allows you to define the coding standards you want to enforce, choose specific code sniffers, and customize various settings.
45-
46-
47-
## Conclusion
4834
49-
EasyCodingStandard is a valuable tool for maintaining a clean and consistent codebase in your PHP projects. By automating code formatting and enforcing coding standards, ECS saves you time, reduces errors, and promotes collaboration within your team.
5035
5136
---
5237

0 commit comments

Comments
 (0)