Skip to content

Commit 389a912

Browse files
committed
docs: apply consistent title case across headings
Use Chicago-style title case: capitalize first/last word and all major words; lowercase articles (a, an, the), coordinating conjunctions (and, but, or, nor, for, so, yet), and prepositions regardless of length (with, from, after, between, across, etc.). Also fix the "Mode :" / "Emulation :" stray spaces before colons in extension-workers.md, capitalize "User" in the parenthetical, and title-case "Real-Time", "PHP Config", and the lowercase "packages"/ "binary" / "Component" / "using" cases that slipped in.
1 parent 69d8eb8 commit 389a912

12 files changed

Lines changed: 23 additions & 23 deletions

docs/compile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Compile FrankenPHP from sources with libphp.so
2+
title: Compile FrankenPHP from Sources with libphp.so
33
description: Build FrankenPHP from source on Linux, macOS and FreeBSD, linking PHP as a shared library via xcaddy or go build, and add custom Caddy modules and extensions.
44
---
55

6-
# Compile From Sources
6+
# Compile from Sources
77

88
This document explains how to create a FrankenPHP binary that will load PHP as a dynamic library.
99
This is the recommended method.

docs/config.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Configuring FrankenPHP With Caddyfile, php.ini, and Env Vars
2+
title: Configuring FrankenPHP with Caddyfile, php.ini, and Env Vars
33
description: Configure FrankenPHP and Caddy via Caddyfile, JSON, or environment variables, including PHP runtime tuning, worker mode, file watching, and module options.
44
---
55

@@ -53,7 +53,7 @@ RUN cp $PHP_INI_DIR/php.ini-production $PHP_INI_DIR/php.ini
5353
RUN cp $PHP_INI_DIR/php.ini-development $PHP_INI_DIR/php.ini
5454
```
5555

56-
## RPM and Debian packages
56+
## RPM and Debian Packages
5757

5858
FrankenPHP:
5959

@@ -65,7 +65,7 @@ PHP:
6565
- `php.ini`: `/etc/php-zts/php.ini` (a `php.ini` file with production presets is provided by default)
6666
- additional configuration files: `/etc/php-zts/conf.d/*.ini`
6767

68-
## Static binary
68+
## Static Binary
6969

7070
FrankenPHP:
7171

@@ -248,7 +248,7 @@ where the FrankenPHP process was started. You can instead also specify one or mo
248248

249249
The file watcher is based on [e-dant/watcher](https://github.com/e-dant/watcher).
250250

251-
## Matching the Worker To a Path
251+
## Matching the Worker to a Path
252252

253253
In traditional PHP applications, scripts are always placed in the public directory.
254254
This is also true for worker scripts, which are treated like any other PHP script.
@@ -271,7 +271,7 @@ and otherwise forward the request to the worker matching the path pattern.
271271
}
272272
```
273273

274-
## Restarting Threads After a Number of Requests (Experimental)
274+
## Restarting Threads after a Number of Requests (Experimental)
275275

276276
FrankenPHP can automatically restart PHP threads after they have handled a given number of requests.
277277
When a thread reaches the limit, it is fully restarted,
@@ -303,7 +303,7 @@ As for FPM and CLI SAPIs, environment variables are exposed by default in the `$
303303

304304
The `S` value of [the `variables_order` PHP directive](https://www.php.net/manual/en/ini.core.php#ini.variables-order) is always equivalent to `ES` regardless of the placement of `E` elsewhere in this directive.
305305

306-
## PHP config
306+
## PHP Config
307307

308308
To load [additional PHP configuration files](https://www.php.net/manual/en/configuration.file.php#configuration.file.scan),
309309
the `PHP_INI_SCAN_DIR` environment variable can be used.

docs/docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ EOF
175175
USER ${USER}
176176
```
177177

178-
### Running With No Capabilities
178+
### Running with No Capabilities
179179

180180
Even when running rootless, FrankenPHP needs the `CAP_NET_BIND_SERVICE` capability to bind the
181181
web server on privileged ports (80 and 443).

docs/embed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Embedding PHP Apps as Standalone Binaries with FrankenPHP
33
description: How to package a PHP application (including Symfony or Laravel) as a self-contained static binary with FrankenPHP, the PHP interpreter, PHP extensions and Caddy.
44
---
55

6-
# PHP Apps As Standalone Binaries
6+
# PHP Apps as Standalone Binaries
77

88
FrankenPHP has the ability to embed the source code and assets of PHP applications in a static, self-contained binary.
99

docs/extension-workers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func init() {
3939
}
4040
```
4141

42-
### In a Caddy Module (Configurable by the user)
42+
### In a Caddy Module (Configurable by the User)
4343

4444
If you plan to share your extension (like a generic queue or event listener), you should wrap it in a Caddy module. This allows users to configure the script path and thread count via their `Caddyfile`. This requires implementing the `caddy.Provisioner` interface and parsing the Caddyfile ([see the frankenphp-queue Caddy module example](https://github.com/dunglas/frankenphp-queue/blob/main/caddy.go)).
4545

@@ -51,7 +51,7 @@ If you are [embedding FrankenPHP in a standard Go application without caddy](htt
5151

5252
Once the worker pool is active, you can dispatch tasks to it. This can be done inside [native functions exported to PHP](https://frankenphp.dev/docs/extensions/#writing-the-extension), or from any Go logic such as a cron scheduler, an event listener (MQTT, Kafka), or any other goroutine.
5353

54-
### Headless Mode : `SendMessage`
54+
### Headless Mode: `SendMessage`
5555

5656
Use `SendMessage` to pass raw data directly to your worker script. This is ideal for queues or simple commands.
5757

@@ -85,7 +85,7 @@ func my_queue_push(data *C.zval) bool {
8585
}
8686
```
8787

88-
### HTTP Emulation :`SendRequest`
88+
### HTTP Emulation: `SendRequest`
8989

9090
Use `SendRequest` if your extension needs to invoke a PHP script that expects a standard web environment (populating `$_SERVER`, `$_GET`, etc.).
9191

docs/internals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Set(Ready)
153153
state is Ready → normal execution
154154
```
155155

156-
## CGO Boundary Between Go and PHP
156+
## CGO Boundary between Go and PHP
157157

158158
### Exported Go Functions
159159

@@ -190,7 +190,7 @@ while ((scriptName = go_frankenphp_before_script_execution(thread_index))) {
190190

191191
Bailouts (fatal PHP errors) are caught by `zend_catch`, which marks the thread as unhealthy and forces cleanup.
192192

193-
### Memory Management Across the CGO Boundary
193+
### Memory Management across the CGO Boundary
194194

195195
- **Go → C strings**: `C.CString()` allocates with `malloc()`. The C side is responsible for freeing (e.g., `frankenphp_free_request_context()` frees cookie data).
196196
- **Go string pinning**: `phpThread` (in `phpthread.go`) embeds Go's [`runtime.Pinner`](https://pkg.go.dev/runtime#Pinner). `thread.Pin()` / `thread.Unpin()` keep Go memory referenced from C alive without copying it. The thread is unpinned after each script execution.

docs/laravel.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ See also [how to use Mercure with Octane](#mercure-support).
8686

8787
Learn more about [Laravel Octane in its official documentation](https://laravel.com/docs/octane).
8888

89-
## Laravel Apps As Standalone Binaries
89+
## Laravel Apps as Standalone Binaries
9090

9191
Using [FrankenPHP's application embedding feature](embed.md), it's possible to distribute Laravel
9292
apps as standalone binaries.
@@ -169,7 +169,7 @@ Your app is now ready!
169169
Learn more about the options available and how to build binaries for other OSes in the [applications embedding](embed.md)
170170
documentation.
171171

172-
### Changing The Storage Path
172+
### Changing the Storage Path
173173

174174
By default, Laravel stores uploaded files, caches, logs, etc. in the application's `storage/` directory.
175175
This is not suitable for embedded applications, as each new version will be extracted into a different temporary directory.
@@ -205,7 +205,7 @@ You can use [all directives supported by Mercure](https://mercure.rocks/docs/hub
205205
To publish and subscribe to updates, we recommend using the [Laravel Mercure Broadcaster](https://github.com/mvanduijker/laravel-mercure-broadcaster) library.
206206
Alternatively, see [the Mercure documentation](mercure.md) to do it in pure PHP and JavaScript.
207207

208-
### Running Octane With Standalone Binaries
208+
### Running Octane with Standalone Binaries
209209

210210
It's even possible to package Laravel Octane apps as standalone binaries!
211211

docs/mercure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Real-Time Updates with the FrankenPHP Mercure Hub
33
description: FrankenPHP ships with a built-in Mercure hub for pushing real-time events to browsers over HTTP, as a simpler alternative to WebSockets.
44
---
55

6-
# Real-time
6+
# Real-Time
77

88
FrankenPHP comes with a built-in [Mercure](https://mercure.rocks) hub!
99
Mercure allows you to push real-time events to all the connected devices: they will receive a JavaScript event instantly.

docs/static.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For better performance in heavily concurrent scenarios, consider using the [mima
3838
docker buildx bake --load --set static-builder-musl.args.MIMALLOC=1 static-builder-musl
3939
```
4040

41-
### glibc-Based, Mostly Static Build (With Dynamic Extension Support)
41+
### glibc-Based, Mostly Static Build (with Dynamic Extension Support)
4242

4343
For a binary that supports loading PHP extensions dynamically while still having the selected extensions compiled statically:
4444

docs/symfony.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ $response = new BinaryFileResponse(__DIR__.'/../private-files/file.txt');
142142
// ...
143143
```
144144

145-
## Symfony Apps As Standalone Binaries
145+
## Symfony Apps as Standalone Binaries
146146

147147
Using [FrankenPHP's application embedding feature](embed.md), it's possible to distribute Symfony
148148
apps as standalone binaries.

0 commit comments

Comments
 (0)