docs: improve documentation structure and content

Author: TerrorSquad

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Goran Ninkovic
+Copyright (c) 2025 Goran Ninkovic
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,10 +1,12 @@
 # Blueprint
 
-This repository contains a DDEV configuration alongside various other tools that help us ensure consistency across local environments as well as quality within PHP codebases.
+A curated collection of tools and best practices for PHP development.
 
-## License
-
-This repository is licensed under the MIT license. See [LICENSE.md](LICENSE.md) for more information.
+## Key Features
+- Streamlined local development with [DDEV](https://ddev.com/).
+- Static analysis with [PHPStan](https://phpstan.org/) and [Psalm](https://psalm.dev/).
+- Automated code formatting with [EasyCodingStandard](https://github.com/symplify/easy-coding-standard).
+- Git hooks for quality enforcement.
 
 ## Requirements
 
@@ -29,3 +31,7 @@ curl -sSL https://raw.githubusercontent.com/TerrorSquad/php-blueprint/main/bluep
 3. Follow the instructions on the screen.
 
 4. Commit the changes and push the branch to your repository.
+
+
+## License
+This repository is licensed under the MIT License. See [LICENSE.md](LICENSE.md) for details.

blueprint/.github/CONTRIBUTING.md

@@ -6,17 +6,13 @@ contribution.
 ## Table of Contents
 
 - [Contributions](#contributions)
-  - [Table of Contents](#table-of-contents)
-  - [Initial setup](#initial-setup)
+  - [Initial Setup](#initial-setup)
   - [Contributing](#contributing)
-  - [Conventions used](#conventions-used)
-    - [Branches](#branches)
-    - [Commits and commit messages](#commits-and-commit-messages)
-      - [Commit Message Format](#commit-message-format)
+  - [Branch Naming](#branch-naming)
+  - [Commit Messages](#commit-messages)
   - [Tools We Use](#tools-we-use)
     - [Required Visual Studio Code Extensions](#required-visual-studio-code-extensions)
-    - [Required PHPStorm extensions](#required-phpstorm-extensions)
-      - [Optional PHPStorm extensions](#optional-phpstorm-extensions)
+    - [Required PHPStorm Extensions](#required-phpstorm-extensions)
   - [Code Quality with SonarQube](#code-quality-with-sonarqube)
 
 ## Initial setup
@@ -41,21 +37,20 @@ contribution.
 This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). This ensures git history is
 clean and readable.
 
-### Branches
+### Branch Naming
 
 Branches must be named in the following format:
 
 `<type>/<prefix>-<ticket_number>-<description>`
 
 Where the prefix can be either `PRJ` (for JIRA tickets) or `ERM` (for Easy RedMine tickets).
 
-examples:
+#### Examples:
+- `feature/PRJ-1234-add-login-feature`
+- `fix/ERM-5678-correct-auth-bug`
+- `chore/PRJ-9101-update-dependencies`
 
-- `feature/PRJ-1234-my-new-feature`
-- `fix/ERM-1234-fix-user-auth`
-- `chore/PRJ-1234-update-ci-config`
-
-This will allow us to find the corresponding branches easily within JIRA or ERM.
+This naming convention ensures branches are easily identifiable and traceable to their corresponding tasks or issues.
 
 ### Commits and commit messages
 
@@ -66,10 +61,14 @@ We use Conventional Commits to maintain a clear and informative commit history.
 generation, versioning, and other project
 management tasks.
 
-#### Commit Message Format
+### Commit Messages
+
+Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for clear and consistent commit messages.
 
 Each commit message should adhere to the following format:
 
+#### Format
+
 ```
 <type>[optional scope]: <description>
 
@@ -84,15 +83,20 @@ Each commit message should adhere to the following format:
 - body (optional): A more detailed explanation of the change, if necessary.
 - footer(s) (optional): Additional information like breaking changes or issue references (e.g., "BREAKING CHANGE: ..."
   or "Fixes #123").
+- **type**: The type of change (e.g., feat, fix, chore, docs).
+- **scope** (optional): The area of the codebase affected.
+- **description**: A brief summary of the change.
+- **body** (optional): Detailed explanation, if needed.
+- **footer(s)** (optional): Additional info like breaking changes or issue references.
 
-Examples
+#### Examples
 
 - `feat: add user authentication`
 - `fix(auth): correct password validation error`
 - `chore: update dependencies`
 - `docs: improve installation instructions`
 
-Commitlint will automatically append the ticket Id to the commit message `footer`. This way you can focus on the title and optionally the body.
+Commitlint will automatically append the ticket ID to the commit message `footer`. Focus on the title and optionally the body.
 
 ## Tools We Use
 

docs/app.config.ts

@@ -33,7 +33,7 @@ export default defineAppConfig({
     footer: {
       credits: {
         icon: '🚀',
-        text: 'By Goran Ninkovic 2024',
+        text: 'By Goran Ninkovic ' + new Date().getFullYear() ,
         href: 'https://goranninkovic.com'
       },
       fluid: false

docs/content/0.index.md

@@ -12,7 +12,7 @@ main:
 ---
 cta:
   - Explore Now
-  - /development_environment/wsl
+  - /integration_guide/integration_guide
 secondary:
   - Star on GitHub
   - https://github.com/TerrorSquad/php-blueprint/
@@ -30,7 +30,7 @@ The PHP Blueprint provides a curated collection of best practices, tools, and re
   - Early bug detection with [PHPStan](https://phpstan.org/) and [Psalm](https://psalm.dev/)
   - Consistent code style with [EasyCodingStandard](https://github.com/easy-coding-standard/easy-coding-standard)
   - Effortless code modernization with [Rector](https://getrector.org/)
-  - Automated workflows with Git hooks and [CommitLint](https://commitlint.js.org/) 
+  - Automated workflows with Git hooks and [CommitLint](https://commitlint.js.org/)
   - Clear API documentation with [Swagger-PHP](https://zircote.github.io/swagger-php/) and [ReDoc](https://github.com/Redocly/redoc)
   - And much more...
   ::
@@ -83,7 +83,7 @@ Key Features
   #title
   Commit Message Linting
   #description
-  Ensure clear and consistent commit messages with [CommitLint](https://commitlint.js.org/) 
+  Ensure clear and consistent commit messages with [CommitLint](https://commitlint.js.org/)
   ::
 
   ::card{icon=noto:gear}

docs/content/1.integration_guide/_dir.yml

@@ -0,0 +1,2 @@
+title: "Integration Guide"
+icon: heroicons-outline:cog

docs/content/1.integration_guide/integration_guide.md

@@ -0,0 +1,25 @@
+# Quick Start
+
+Follow these steps to integrate the PHP Development Booster into your existing PHP project:
+
+1. **Prepare Your Project**:
+   - Ensure your PHP project is under version control (e.g., Git).
+   - Check out a new branch and ensure there are no uncommitted changes.
+
+2. **Run the Integration Script**:
+   Execute the following command in your project root to integrate the booster:
+   ```bash
+   curl -sSL https://raw.githubusercontent.com/TerrorSquad/php-development-booster/main/blueprint/integrate_blueprint.sh | bash
+   ```
+
+3. **Complete the Integration**:
+   - Follow the on-screen instructions provided by the script.
+   - Review the changes made to your project.
+
+4. **Commit and Push**:
+   - Commit the changes to your branch:
+     ```bash
+     git add .
+     git commit -m "Integrate PHP Development Booster"
+     ```
+   - Push the branch to your repository and create a pull request for review.