Skip to content

Adds comprehensive context key reference to docs - #8420

Merged
mabuyo merged 11 commits into
devfrom
doc-context-keylist
Oct 16, 2025
Merged

Adds comprehensive context key reference to docs#8420
mabuyo merged 11 commits into
devfrom
doc-context-keylist

librarian edits: codefont booleans, edit awkward phrasing

e43791a
Select commit
Loading
Failed to load commit list.
Apollo Librarian / AI Style Review succeeded Oct 16, 2025 in 52s

Style Review Completed

The pull request has 2 style issues.

Duration: 733ms
PR URL: #8420
Review Comments: The AI has posted 2 inline comments with suggestions

Summary of changes:

The documentation was updated to avoid the use of 'we' and to format boolean values like 'true' and 'false' using code font. Additionally, a sentence was rephrased to follow best practices for link placement.

⚠️ 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 405 in docs/source/routing/customization/coprocessor/reference.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/routing/customization/coprocessor/reference.mdx#L405

Avoid using 'we' to prevent ambiguity. Also, use code font for boolean values like `true` and `false`.

```suggestion
- <code>apollo::apq::cache_hit</code> - Present if the request used APQ; <code>true</code> if a cache hit occurred for the query ID, <code>false</code> otherwise
```

Check notice on line 97 in docs/source/routing/customization/overview.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/routing/customization/overview.mdx#L97

Rephrase the sentence to better align with linking best practices, which recommend placing links at the end of a sentence when possible.

```suggestion
For a complete list of available context keys, see the [Coprocessor Reference documentation](/graphos/routing/customization/coprocessor/reference#context-key-reference).
```