Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: address AI Gateway documentation review feedback - #28309

Merged
pawbana merged 9 commits into
mainfrom
pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2
Aug 23, 2026
Merged

docs: address AI Gateway documentation review feedback#28309
pawbana merged 9 commits into
mainfrom
pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2

Conversation

@pawbana

@pawbana pawbana commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Note: Due to number of comments left in #27794 I delegated the work to the agent.
I only checked if final result looks ok, not if everything was addressed.

Applies the review feedback from #27794. Prose only.

Metric table generation is out of scope here and is tracked in AIGOV-561. This PR is based on main and no longer stacked on #28307, which is now a draft.

  • Use "AI Gateway" for the feature and "gateway" for an individual gateway instance.
  • Split long paragraphs into one sentence per line.
  • Stop advertising the /api/v2/ai-gateway path prefix on the standalone listener, which was documented in error, and call the prefix a path prefix where it is mentioned.
  • Describe the AI Gateway API version as the compatibility criterion between a standalone replica and coderd, rather than the component versions.
  • Describe standalone state as non-authoritative rather than absent, and describe the readiness and provider reload behavior accurately.
  • Link to in-repo files such as the AI Gateway Helm chart README with relative links, so they resolve to the matching revision.
  • Rename the gerund-leading headings that Coder.GerundHeading flags on the touched pages, to the imperative for task sections and the noun for concept sections, and update the links that point at them.
Deviations from the suggested wording

Most suggestions were applied verbatim. These were not, because the suggested text would have been inaccurate:

  • Gateway key permissions (r3706423944, r3706566830): only the built-in owner role carries site-level ai_gateway_key permissions. Custom roles are organization-scoped, and enterprise/coderd/roles.go rejects site permissions on them, so the pages keep that caveat.
  • Standalone state (r3706379362): "hold no durable state" overstates it. Replicas keep in-memory provider snapshots, caches, and metrics, and can write API dumps to local disk. They hold no authoritative database state.
Verification
  • make pre-commit passes on main, including lint/markdown, lint/emdash, and lint/docs-html.
  • vale reports no Coder.GerundHeading warnings on any touched page.
  • Every anchor renamed by a heading change was grepped for across docs/ and site/, and the referring links were updated.
  • Factual claims about RBAC, readiness, provider reload, version negotiation, and the BYOK flag were each checked against the source.

This pull request was prepared by Coder Agents.

@linear-code

linear-code Bot commented Aug 19, 2026

Copy link
Copy Markdown

AIGOV-573

@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from cfb0cf9 to 2113b3a Compare August 19, 2026 16:11
@pawbana pawbana changed the title chore: update standalone AI Gateway docs docs: address AI Gateway documentation review feedback Aug 19, 2026
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from d57572a to 3e4534a Compare August 19, 2026 16:27
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from 2113b3a to ed94f03 Compare August 19, 2026 17:27
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from 3e4534a to 344ba4f Compare August 19, 2026 17:28
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from ed94f03 to 32c6536 Compare August 19, 2026 18:33
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from 344ba4f to 33d06e3 Compare August 19, 2026 18:33
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from 32c6536 to 68c04e1 Compare August 19, 2026 19:23
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from 33d06e3 to b929b0d Compare August 19, 2026 19:24
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from 68c04e1 to 1ff1a44 Compare August 19, 2026 19:26
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from b929b0d to 68862b5 Compare August 19, 2026 19:26
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from 1ff1a44 to 4c585ed Compare August 19, 2026 20:14
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from 68862b5 to 600c1f5 Compare August 19, 2026 20:14
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from 4c585ed to d763821 Compare August 19, 2026 20:49
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from 600c1f5 to 74de6b8 Compare August 19, 2026 20:49
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from d763821 to 9de2228 Compare August 19, 2026 21:11
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from 74de6b8 to 536cfa9 Compare August 19, 2026 21:11
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback branch from 9de2228 to b019df6 Compare August 19, 2026 21:32
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch 2 times, most recently from 287e398 to 2fab335 Compare August 20, 2026 15:30
@pawbana
pawbana changed the base branch from pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback to main August 20, 2026 15:30
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch 3 times, most recently from 1287082 to 7f37566 Compare August 20, 2026 16:44
Apply the documentation review feedback from #27794, which was merged as
a backport before the comments could be addressed.
@pawbana
pawbana force-pushed the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch from 7f37566 to 31cbaf4 Compare August 20, 2026 16:57
@pawbana
pawbana marked this pull request as ready for review August 20, 2026 17:46
@pawbana
pawbana requested a review from nickvigilante August 20, 2026 17:46

@nickvigilante nickvigilante left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work. Thank you for this! Approved with changes :shipit: 🚀

Comment thread docs/ai-coder/ai-gateway/ai-gateway-proxy/setup.md Outdated
Comment thread docs/ai-coder/ai-gateway/clients/copilot.md Outdated
Comment thread docs/ai-coder/ai-gateway/clients/copilot.md Outdated
Comment thread docs/ai-coder/ai-gateway/clients/copilot.md Outdated
Comment on lines +13 to 14
We provide an example Grafana dashboard that you can import as a starting point for your metrics.
Refer to the [Grafana dashboard README](../../../examples/monitoring/dashboards/grafana/aibridge/README.md).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I generally avoid using first-person pronouns, but in this case, "we" is the company, so this is an acceptable exception. Just an FYI, no action needed.

Comment thread docs/ai-coder/ai-gateway/reference.md Outdated
Comment thread docs/ai-coder/ai-gateway/standalone.md Outdated
Comment thread docs/ai-coder/ai-gateway/standalone.md Outdated
Comment thread docs/ai-coder/ai-gateway/standalone.md Outdated
@pawbana
pawbana enabled auto-merge (squash) August 23, 2026 19:39
@pawbana
pawbana merged commit 4ce8e8e into main Aug 23, 2026
29 checks passed
@pawbana
pawbana deleted the pawel/aigov-573-docs-address-ai-gateway-documentation-review-feedback-2 branch August 23, 2026 19:42
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 23, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants