Skip to content

Commit 4826f0c

Browse files
committed
Update project structure documentation in README
This commit updates the project structure section in the README to accurately reflect the current organization: - Add new docs/ directory that contains markdown documentation and generated API documentation - Clarify that app/ is the default application directory, which can be customized via APP_DIR - Add data/ directory structure which contains database files and dumps - Improve descriptions to better explain the purpose of each directory - Reorganize the structure to show logical groupings of related directories This updated documentation gives users a clearer understanding of the project organization and helps them navigate the codebase more effectively.
1 parent b2c4025 commit 4826f0c

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -312,10 +312,16 @@ With this setup, you'll have a powerful debugging environment that helps you ide
312312
│ ├── php/ # PHP configuration
313313
│ └── ssl/ # SSL certificates
314314
├── web/ # Web root directory
315-
│ └── app/ # Application code
315+
│ └── app/ # Default application code
316316
│ ├── public/ # Public files
317317
│ ├── src/ # Source files
318318
│ └── tests/ # Test code
319+
├── docs/ # Documentation
320+
│ ├── api/ # API documentation (generated)
321+
│ └── *.md # Markdown documentation files
322+
├── data/ # Persistent data
323+
│ └── db/ # Database files
324+
│ └── dumps/ # Database dumps
319325
├── .env.dev # Development environment variables
320326
├── .env.prod # Production environment variables
321327
├── docker-compose.yml # Docker Compose configuration

0 commit comments

Comments
 (0)