Skip to content

Commit 0a36906

Browse files
authored
Merge pull request #16 from dotkernel/issue-41
Issue #15: Documentation cleanup
2 parents 548ebb5 + baf9328 commit 0a36906

3 files changed

Lines changed: 7 additions & 13 deletions

File tree

docs/book/v1/introduction/file-structure.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This folder contains all service-related local and global config files:
3939
* `error-handling.global.php` - Configures and activates error logs
4040
* `local.php.dist` - Local config file where you can overwrite application name and URL
4141
* `mezzio.global.php` - Mezzio core config file
42-
* `templates.global.php` - dotkernel/dot-twigrenderer config file
42+
* `templates.global.php` - mezzio/mezzio-twigrenderer config file
4343

4444
## `data/cache` folder
4545

@@ -56,7 +56,6 @@ This folder contains all publicly available assets and serves as the entry point
5656

5757
* `css` and `js` - Contains the css and js file(s) generated by the webpack (npm) from the assets folder
5858
* `fonts` and `images` - Contain the font and image file(s) copied by the webpack (npm) from the assets folder
59-
* `uploads` - a folder that normally contains admin avatar images
6059
* `.htaccess` - server configuration file used by Apache web server; it enables the URL rewrite functionality
6160
* `index.php` - the application's main entry point
6261
* `robots.txt.dist` - a sample robots.txt file that allows/denies bot access to certain areas of your application; activate it by duplicating the file as `robots.txt` and comment out the lines that don't match your environment
@@ -67,19 +66,17 @@ This folder contains a separate folder for each Module.
6766

6867
These are the modules included by default:
6968

70-
* `App` - Core functionality, from authentication, to rendering, to error reporting
69+
* `App` - Core functionality, from rendering, to error reporting
7170
* `Page` - Contains functionality for displaying a page
7271

7372
### Module contents
7473

7574
Each Module folder, in turn, should contain the following folders, unless they are empty:
7675

77-
* `src/Controller` - Action classes
76+
* `src/Factory` - Factories which provide handler/service dependencies
77+
* `src/Handler` - Request handlers
7878
* `src/Service` - Service classes
7979

80-
The above example is just some of the folders a project may include, but they should give you an idea about the recommended structure.
81-
Other classes the `src` folder may include are `InputFilter`, `EventListener`, `Helper`, `Command`, `Factory` etc.
82-
8380
The `src` folder in each Module folder normally also contains these files:
8481

8582
* `ConfigProvider.php` - Configuration data for the module
@@ -89,5 +86,5 @@ The `src` folder in each Module folder normally also contains these files:
8986

9087
This directory contains the template files.
9188

92-
> `twig` is used as Templating Engine.
89+
> `Twig` is used as templating engine.
9390
> All template files have the extension `.html.twig`.
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# Packages
22

3-
* `dotkernel/dot-controller` - Provides base classes for action based controllers similar to Laminas controller component
43
* `dotkernel/dot-errorhandler` - Logging Error Handler for Middleware Applications
5-
* `dotkernel/dot-twigrenderer` - Dotkernel component providing twig extensions and customizations
6-
* `friendsofphp/proxy-manager-lts` - Fork of ocramius/proxy-manager
74
* `laminas/laminas-component-installer` - Composer plugin for injecting modules and configuration providers into application configuration
85
* `laminas/laminas-config-aggregator` - Lightweight library for collecting and merging configuration from different sources
96
* `mezzio/mezzio` - PSR-15 Middleware Microframework
107
* `mezzio/mezzio-fastroute` - FastRoute integration for Mezzio
8+
* `mezzio/mezzio-twigrenderer` - Twig integration for Mezzio

docs/book/v1/introduction/server-requirements.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,13 @@ For production, we highly recommend a *nix based system.
1515

1616
You need to convert the provided Apache related `.htaccess` file into Nginx configuration instructions.
1717

18-
## PHP >= 8.2
18+
## PHP: 8.2, 8.3 or 8.4
1919

2020
Both mod_php and FCGI (FPM) are supported.
2121

2222
## Required Settings and Modules & Extensions
2323

2424
* memory_limit >= 128M
25-
* upload_max_filesize and post_max_size >= 100M (depending on your data)
2625
* mbstring
2726
* Composer (added to $PATH)
2827

0 commit comments

Comments
 (0)