Skip to content

Commit 636b1bd

Browse files
committed
docs: simplify page titles and improve command formatting
1 parent d72475b commit 636b1bd

File tree

5 files changed

+25
-14
lines changed

5 files changed

+25
-14
lines changed

docs/content/3.tools/3.static_analysis.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,11 @@ composer phpstan
3535
composer phpstan:sonar
3636
```
3737

38-
If you're using DDEV, you can run these commands within your DDEV environment:
39-
40-
```bash
41-
ddev composer phpstan
42-
ddev composer phpstan:sonar
43-
```
38+
* If you're using DDEV, you can run these commands within your DDEV environment:
39+
```bash
40+
ddev composer phpstan
41+
ddev composer phpstan:sonar
42+
```
4443
4544
### Configuration
4645
* The `phpstan.neon.dist` file in your project root provides the base configuration for PHPStan. You can customize it further by creating a `phpstan.neon` file to override or extend the default settings.

docs/content/3.tools/4.git_hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ navigation: true
44
layout: default
55
---
66

7-
# Git Hooks: Automate Your Workflow and Enforce Quality
7+
# Git Hooks
88

99
## Introduction
1010

docs/content/3.tools/5.api_documentation.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ navigation: true
44
layout: default
55
---
66

7-
# API Documentation: Illuminate Your Endpoints with Swagger-PHP and ReDoc
7+
# API Documentation
88

99
## Introduction
1010

@@ -26,9 +26,14 @@ Clear and comprehensive API documentation is essential for effective communicati
2626
* This file uses Swagger-PHP to scan your annotated code and generate the specification
2727
* You can trigger the generation process using the following Composer script within your DDEV environment
2828
```bash
29-
ddev composer generate-api-spec
29+
composer generate-api-spec
3030
```
3131

32+
* If you're using DDEV, you can run these commands within your DDEV environment:
33+
```bash
34+
ddev composer generate-api-spec
35+
```
36+
3237
3. **View Your API Documentation (Optional):**
3338
* While the `openapi.yml` file itself is machine-readable, you can use tools like ReDoc to generate human-readable, interactive documentation
3439
* **Note:** ReDoc integration is included in the Booster. Check out the `package.json` for the `generate:api-doc:html` script, which uses ReDoc to generate the HTML documentation

docs/content/3.tools/6.ide_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ navigation: true
44
layout: default
55
---
66

7-
# IDE Configuration: Optimize Your Development Experience
7+
# IDE Configuration
88

99
## Introduction
1010

docs/content/3.tools/7.sonarqube.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ navigation: true
44
layout: default
55
---
66

7-
# SonarQube Integration: Elevate Code Quality Analysis
7+
# SonarQube Integration
88

99
## Introduction
1010

11-
SonarQube is a powerful open-source platform for continuous code quality inspection. It provides insights into code reliability, security, maintainability, and technical debt, helping you improve your codebase over time.
11+
[SonarQube](https://www.sonarsource.com/products/sonarqube/) is a powerful open-source platform for continuous code quality inspection. It provides insights into code reliability, security, maintainability, and technical debt, helping you improve your codebase over time.
1212

1313
In this Booster, we've included the necessary configurations to integrate your PHP project with SonarQube, allowing you to leverage its advanced analysis capabilities.
1414

@@ -35,13 +35,20 @@ SonarQube offers a range of benefits for PHP developers and teams
3535
* Run the following commands within your DDEV environment
3636
* For PHPStan analysis
3737
```bash
38-
ddev phpstan:sonar
38+
composer phpstan:sonar
3939
```
4040
* For Psalm analysis
4141
```bash
42-
ddev psalm:sonar
42+
composer psalm:sonar
4343
```
4444

45+
46+
* If you're using DDEV, you can run these commands within your DDEV environment:
47+
```bash
48+
ddev composer phpstan:sonar
49+
ddev composer psalm:sonar
50+
```
51+
4552
4. **Run SonarQube Analysis (Within your CI/CD pipeline):**
4653
* The `.github/workflows/sonarqube.yml` file defines a GitHub Actions workflow to run SonarQube analysis on every push to your repository
4754
* This workflow will execute the `phpstan:sonar` and `psalm:sonar` scripts, then use the SonarQube Scanner to upload the generated reports to your SonarQube server

0 commit comments

Comments
 (0)