Skip to content

doc: reinstate header_read_timeout documentation - #8789

Merged
carodewig merged 3 commits into
devfrom
caroline/docs-server-read
Jan 5, 2026
Merged

doc: reinstate header_read_timeout documentation#8789
carodewig merged 3 commits into
devfrom
caroline/docs-server-read

Merge branch 'dev' into caroline/docs-server-read

75ccffa
Select commit
Loading
Failed to load commit list.
Apollo Librarian / AI Style Review succeeded Jan 5, 2026 in 1m 16s

Style Review Completed

The pull request has 3 style issues.

Duration: 809ms
PR URL: #8789
Review Comments: The AI has posted 3 inline comments with suggestions

Summary of changes:

Documentation has been updated to use sentence casing for headings, present tense and active voice, and to use words for numbers zero through ten.

⚠️ This review and suggested changes are AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

Annotations

Check warning on line 315 in docs/source/routing/configuration/yaml.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/routing/configuration/yaml.mdx#L315

Use sentence casing for headings.

```suggestion
#### Header read timeout
```

Check warning on line 317 in docs/source/routing/configuration/yaml.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/routing/configuration/yaml.mdx#L317

Use present tense ("waits" instead of "will wait") and active voice. Use lowercase "router" to refer to the instance.

```suggestion
The header read timeout is the duration the router waits to receive complete request headers from a client. This applies when the connection is idle and when a request starts but the client hasn't finished sending headers.
```

Check warning on line 319 in docs/source/routing/configuration/yaml.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/routing/configuration/yaml.mdx#L319

Use active voice ("Configure..." instead of "can be configured"). Use words for numbers zero through ten ("ten seconds").

```suggestion
The default header read timeout is ten seconds. Configure the timeout with the `server.http.header_read_timeout` option.
```