[DXM-100] Add Redis TLS config shared component #9172
Style Review Completed
The pull request has 6 style issues.
Duration: 2965ms
PR URL: #9172
Review Log: View detailed log
Review Comments: The AI has posted 6 inline comments with suggestions
Summary of changes:
The documentation has been updated to align with the style guide across several sections. In structural-elements, changes include specifying programming languages for syntax highlighting, closing code blocks, and ensuring two newlines are used within admonition components for correct formatting. Text-formatting was improved by replacing vague links with descriptive noun phrases. In framing and voice, instructions were updated to use the imperative mood and an authoritative, helpful tone was adopted by removing permissive phrasing like 'you can' to ensure actionable content.
Annotations
Check warning on line 6 in docs/shared/redis-tls.mdx
apollo-librarian / AI Style Review
docs/shared/redis-tls.mdx#L6
**Structural Elements**: Specify the programming language for syntax highlighting.
```suggestion
```yaml
```
Check warning on line 14 in docs/shared/redis-tls.mdx
apollo-librarian / AI Style Review
docs/shared/redis-tls.mdx#L14
**Structural Elements**: Close the code block.
```suggestion
```
```
Check warning on line 203 in docs/source/routing/operations/apq.mdx
apollo-librarian / AI Style Review
docs/source/routing/operations/apq.mdx#L203
**Structural Elements**: Admonition components require two newlines between the tags and the content.
```suggestion
<RedisTls>
Nest the following configuration under `apq.router.cache`:
</RedisTls>
```
Check warning on line 248 in docs/source/routing/query-planning/caching.mdx
apollo-librarian / AI Style Review
docs/source/routing/query-planning/caching.mdx#L248
**Structural Elements**: Include two newlines between the admonition components and content for proper formatting.
```suggestion
<RedisTls>
Nest the following configuration under `supergraph.query_planning.cache`:
</RedisTls>
```
Check notice on line 17 in docs/shared/redis-tls.mdx
apollo-librarian / AI Style Review
docs/shared/redis-tls.mdx#L17
**Text Formatting**: Use a descriptive noun phrase for link text instead of just repeating the title or using vague references.
```suggestion
For comprehensive TLS configuration details, including client-side and subgraph TLS, see the [TLS configuration documentation](/router/configuration/tls).
```
Check notice on line 1 in docs/shared/redis-tls.mdx
apollo-librarian / AI Style Review
docs/shared/redis-tls.mdx#L1
**Framing**: Use the imperative for instructions to be more direct and actionable.
**Voice**: Use an authoritative and helpful tone rather than presenting options with 'you can'.
```suggestion
For Redis TLS connections, set up a client certificate or override the root certificate authority by configuring `tls` in your router's [YAML config file](/graphos/routing/configuration/overview#yaml-config-file).
```