Skip to content

Commit 46591c1

Browse files
committed
Use one sentence per line in v7 docs
Reflows hard-wrapped prose so each sentence occupies its own line. Line breaks only, no wording changes. Signed-off-by: arhimede <julian@dotkernel.com>
1 parent 275e549 commit 46591c1

36 files changed

Lines changed: 406 additions & 378 deletions

‎docs/book/v7/commands/create-admin-account.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ php ./bin/cli.php help admin:create
5656

5757
**Q: Can I choose the role of the created account?**
5858

59-
A: No. The command always assigns the `admin` role; other roles must be set afterwards.
59+
A: No.
60+
The command always assigns the `admin` role; other roles must be set afterwards.
6061
See [Authorization](../core-features/authorization.md).
6162

6263
**Q: What can I use as the identity?**

‎docs/book/v7/commands/display-available-endpoints.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ php ./bin/cli.php route:list --help
8888

8989
**Q: Is the output generated from a static file?**
9090

91-
A: No. The command walks the application's registered routes in realtime, so it always reflects the current configuration.
91+
A: No.
92+
The command walks the application's registered routes in realtime, so it always reflects the current configuration.
9293

9394
**Q: Which filters are available?**
9495

‎docs/book/v7/commands/generate-database-migrations.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ Run the following command in your application’s root directory:
1313
vendor/bin/doctrine-migrations diff
1414
```
1515

16-
If you have mapping modifications, this will create a new migration file under
17-
`src/Core/src/App/src/Migration/`, in the `Core\App\Migration` namespace.
16+
If you have mapping modifications, this will create a new migration file under `src/Core/src/App/src/Migration/`, in the `Core\App\Migration` namespace.
1817
The location comes from the `doctrine.migrations.migrations_paths` key in `Core\App\ConfigProvider`.
1918
Opening the migration file, you will notice that it contains some queries that will drop your `oauth_*` tables because they are unmapped (there is no doctrine entity describing them).
2019
You should delete your latest migration with the DROP queries in it as we will create another one, without the DROP queries in it.

‎docs/book/v7/commands/generate-tokens.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,5 @@ Clear it with `php ./bin/clear-config-cache.php`.
9898

9999
**Q: Does the command store the token for me?**
100100

101-
A: No. It only prints the value; copying it into the configuration file is a manual step.
101+
A: No.
102+
It only prints the value; copying it into the configuration file is a manual step.

‎docs/book/v7/core-features/authentication.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ Authentication in Dotkernel API is built around the `mezzio/mezzio-authenticatio
2727
To customize authentication behavior (token lifetimes, algorithms, etc.), edit `config/autoload/local.php` under the `authentication` key.
2828
See the [Mezzio OAuth2 documentation](https://docs.mezzio.dev/mezzio-authentication-oauth2/v1/intro/#configuration) for all available options.
2929

30-
> You can check the
31-
> [mezzio/mezzio-authentication-oauth2](https://docs.mezzio.dev/mezzio-authentication-oauth2/v1/intro/#configuration)
32-
> configuration part for more info.
30+
> You can check the [mezzio/mezzio-authentication-oauth2](https://docs.mezzio.dev/mezzio-authentication-oauth2/v1/intro/#configuration) configuration part for more info.
3331
3432
## How it works
3533

@@ -250,5 +248,6 @@ See [Middleware flow](../flow/middleware-flow.md).
250248

251249
**Q: Is authenticating enough to access an endpoint?**
252250

253-
A: No. Authentication establishes the identity; the role still needs permission for the route.
251+
A: No.
252+
Authentication establishes the identity; the role still needs permission for the route.
254253
See [Authorization](authorization.md).

‎docs/book/v7/core-features/authorization.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,8 @@ Because the middleware only knows `AuthorizationInterface`, no application code
194194

195195
**Q: Do the permissions cover every route?**
196196

197-
A: Yes, exactly. The three populated roles grant 38 permissions across the 38 declared routes, with no route ungranted and no permission naming a route that does not exist.
197+
A: Yes, exactly.
198+
The three populated roles grant 38 permissions across the 38 declared routes, with no route ungranted and no permission naming a route that does not exist.
198199
`app::view-index` and `app::create-error-report` are the only two granted to two roles.
199200

200201
**Q: What does a rejected request look like?**

‎docs/book/v7/core-features/content-validation.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,8 @@ A: The server attempts to deserialize the body as best it can, rather than rejec
129129

130130
**Q: Will `application/vnd.api+json` be rejected if I only configured `application/json`?**
131131

132-
A: No. Validation resolves to the more generic media type, so the request is served as JSON.
132+
A: No.
133+
Validation resolves to the more generic media type, so the request is served as JSON.
133134

134135
**Q: How do I configure a file upload endpoint?**
135136

‎docs/book/v7/core-features/error-reporting.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,8 @@ A: The log entry includes the token used, and tokens can be defined as key-value
166166

167167
**Q: Do these tokens expire?**
168168

169-
A: No. Because they are indefinite, rotate them manually from time to time.
169+
A: No.
170+
Because they are indefinite, rotate them manually from time to time.
170171
See [Basic security](../security/basic-security.md).
171172

172173
**Q: Where do the reports end up?**
@@ -176,5 +177,6 @@ If it does not exist, it is created automatically.
176177

177178
**Q: Does this endpoint need an auth token as well?**
178179

179-
A: No. It is authorized solely by the error reporting token.
180+
A: No.
181+
It is authorized solely by the error reporting token.
180182
See [Using the documentation](../openapi/use-documentation.md).

‎docs/book/v7/core-features/rendering-and-sending-emails.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ A: Files combining PHP and HTML with the `.phtml` extension.
6363

6464
**Q: Does `MailService` still need a renderer injected?**
6565

66-
A: No. Rendering happens in the handler, and the finished body is passed to the mail service as a parameter.
66+
A: No.
67+
Rendering happens in the handler, and the finished body is passed to the mail service as a parameter.
6768

6869
**Q: How do I render a template and send it?**
6970

‎docs/book/v7/extended-features/core-and-app.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,5 +73,6 @@ See [File structure](../introduction/file-structure.md).
7373

7474
**Q: Was this split present before version 6.0?**
7575

76-
A: No. It was introduced in 6.0 when common logic was moved into the Core module.
76+
A: No.
77+
It was introduced in 6.0 when common logic was moved into the Core module.
7778
See [Upgrading from 5.x to 6.0](../upgrading/UPGRADE-6.0.md).

0 commit comments

Comments
 (0)