Clarify API log retrieval instructions #22811
Conversation
hyperlint-ai
bot
requested review from
a team,
angelampcosta,
elithrar,
irvinebroque,
kathayl,
kodster28,
mchenco,
rita3ko,
soheiokamoto and
thomasgauvin
as code owners
github-actions
bot
added
product:agents
github-actions
bot
assigned
elithrar,
irvinebroque,
rita3ko,
thomasgauvin and
threepointone
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
![windsurf-bot[bot]](https://avatars.githubusercontent.com/in/1066231?s=60&v=4){kind=small}
There was a problem hiding this comment.
Other comments (1)
-
src/content/docs/ai-gateway/evaluations/add-human-feedback-api.mdx (65-65)
The change from 'don't' to 'do not' aligns with formal documentation style guidelines. However, 'you can retrieve it' is more concise than 'you are able to retrieve it' without sacrificing clarity. Consider keeping the expanded contraction but maintaining the more concise phrasing:
If you do not have the `cf-aig-log-id` in the response body or you need to access it after the fact, you can retrieve it by querying the logs using the [Cloudflare API](/api/resources/ai_gateway/subresources/logs/methods/list/).
| <PackageManagers | ||
| type="create" | ||
| pkg="cloudflare@latest" | ||
| pkg="Cloudflare@latest" |
There was a problem hiding this comment.
The package name should remain lowercase as cloudflare@latest. The npm package is published as lowercase 'cloudflare' (https://www.npmjs.com/package/cloudflare), and changing it to 'Cloudflare@latest' would cause the command to fail when executed.
| <PackageManagers | ||
| type="create" | ||
| pkg="cloudflare@latest" | ||
| pkg="Cloudflare@latest" |
There was a problem hiding this comment.
The package name should remain lowercase as cloudflare@latest. The npm package is published as lowercase 'cloudflare' (https://www.npmjs.com/package/cloudflare), and changing it to 'Cloudflare@latest' would cause the command to fail when executed.
| 6. For **Starting Point**, choose \*Clone Public Git Repository\*\*.\*\*\* | ||
|
|
||
| 7. Enter the *cloudflare\_block* URL for the public Git repository `git://github.com/llooker/cloudflare_block.git`. | ||
| 7. Enter the *cloudflare\_block* URL for the public Git repository `git://github.com/looker/cloudflare_block.git`. |
There was a problem hiding this comment.
The GitHub repository URL has been changed from 'llooker' to 'looker'. Please verify that this new URL (git://github.com/looker/cloudflare_block.git) is correct and accessible to ensure we're not breaking the user instructions.
10 participants
This pull request addresses several style guide violations, including incorrect casing for product names and spelling errors. The changes ensure compliance with the specified style guide rules, enhancing the overall quality and consistency of the documentation.
add-human-feedback-api.mdx)add-human-feedback-api.mdx)