Marcelo/router 1609 - #8915
Style Review Completed
The pull request has 3 style issues.
Duration: 2906ms
PR URL: #8915
Review Log: View detailed log
Review Comments: The AI has posted 3 inline comments with suggestions
Summary of changes:
This pull request updates the documentation to align with several style guide requirements. Key changes include: converting unordered list bullets from asterisks to hyphens under structural elements; adopting reader-centric framing by using 'your' for clarity while avoiding possessives before standalone product names; and ensuring proper article usage for product components. Technical formatting was improved by switching version numbers to plain text and replacing 'may' with 'can' or 'might' for clarity. Additionally, the tone was refined by using present tense over future tense, adopting authoritative and encouraging language, and incorporating valid contractions for better readability.
Annotations
Check warning on line 5 in docs/shared/otel-envvars-caution.mdx
apollo-librarian / AI Style Review
docs/shared/otel-envvars-caution.mdx#L5
**Structural Elements**: Use hyphens (-) instead of asterisks for unordered list bullets.
```suggestion
- `OTEL_EXPORTER_OTLP_ENDPOINT`
```
Check warning on line 6 in docs/shared/otel-envvars-caution.mdx
apollo-librarian / AI Style Review
docs/shared/otel-envvars-caution.mdx#L6
**Structural Elements**: Use hyphens (-) instead of asterisks for unordered list bullets.
```suggestion
- `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`
```
Check warning on line 7 in docs/shared/otel-envvars-caution.mdx
apollo-librarian / AI Style Review
docs/shared/otel-envvars-caution.mdx#L7
**Structural Elements**: Use hyphens (-) instead of asterisks for unordered list bullets.
```suggestion
- `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`
```
Check notice on line 3 in docs/shared/otel-envvars-caution.mdx
apollo-librarian / AI Style Review
docs/shared/otel-envvars-caution.mdx#L3
**Framing**: Use reader-centric language by adding "your" to clarify ownership of the router.
**Products and Features**: Use an article before a component of a product like 'router's built-in telemetry configuration'.
**Verb Tense and Voice**: Use present tense instead of future tense.
```suggestion
The following OpenTelemetry (OTEL) environment variables will override your router's built-in telemetry configuration:
```
Check warning on line 9 in docs/shared/otel-envvars-caution.mdx
apollo-librarian / AI Style Review
docs/shared/otel-envvars-caution.mdx#L9
**Framing**: Use reader-centric language ("your") and more direct phrasing.
**Products and Features**: Use an article before a component of a product like 'router's telemetry settings'.
**Text Formatting**: Use plain text for version numbers, not code font.
**Verb Tense and Voice**: Use present tense instead of future tense.
**Word and Symbol Usage**: Avoid 'may'; use 'can' for capability or 'might' for potential occurrence.
```suggestion
In Apollo Router v2.12.0 and earlier, these variables override your router's telemetry settings and may cause traces or metrics to be sent to an unintended destination.
```
Check warning on line 13 in docs/shared/otel-envvars-caution.mdx
apollo-librarian / AI Style Review
docs/shared/otel-envvars-caution.mdx#L13
**Products and Features**: Avoid using possessives like 'your' before a standalone product name.
**Text Formatting**: Use plain text for version numbers, not code font.
**Verb Tense and Voice**: Use present tense instead of future tense.
**Voice**: Use authoritative and encouraging language to prescribe the correct action.
**Word and Symbol Usage**: Use dictionary-valid contractions like 'won't' for better readability.
```suggestion
In Apollo Router v2.13.0 and later, the router will not start if any of these variables are set. Remove them from your environment before launching.
```