Polish Stacklok Enterprise documentation - #1146
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR performs an editorial pass across the Stacklok Enterprise docs set (platform, Enterprise Manager, directory, console, Enterprise authorization) plus the AI Gateway and Connector Gateway sections, aiming to reduce verbosity, tighten information architecture, and standardize troubleshooting patterns while also applying Enterprise-only signaling in navigation and fixing a sidebar tooltip positioning issue.
Changes:
- Streamlines and clarifies Enterprise/platform and gateway documentation, removing redundant/LLM-like phrasing and tightening “why/what to do next” flow.
- Consolidates/removes redundant pages (notably removing the standalone “what you can see” concepts page) and updates cross-links and sidebar navigation accordingly.
- Standardizes troubleshooting sections using
<details>blocks and adjusts UI styling so the first-item Enterprise badge tooltip doesn’t collide with top navigation.
Reviewed changes
Copilot reviewed 50 out of 50 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/css/custom.css | Adds a modifier class to place the Enterprise badge tooltip below the first sidebar item to avoid overlap with top nav. |
| sidebars.ts | Renames/replaces the platform client-connection page, removes the visibility concept page, and marks gateway landing pages as Enterprise-only in the sidebar. |
| docs/platform/reference/crds/index.mdx | Tightens CRD reference intro copy for clarity and concision. |
| docs/platform/index.mdx | Editorial rewrite of the Enterprise overview and capability tables; improves consistency and reduces verbosity. |
| docs/platform/enterprise-platform/verify-artifacts.mdx | Condenses artifact verification guidance and standardizes troubleshooting to <details>. |
| docs/platform/enterprise-platform/roll-out-gateway-clients.mdx | Adds a new rollout-focused page guiding admins to console-generated, deployment-specific client setup instructions. |
| docs/platform/enterprise-platform/index.mdx | Tightens platform intro and updates rollout step/link to the new gateway client rollout page. |
| docs/platform/enterprise-platform/distributed-deployments.mdx | Simplifies distributed deployment explanation and trims redundant callouts. |
| docs/platform/enterprise-platform/deployment.mdx | Refactors deployment guide for clarity, reduces repetition, and adds a <details>-based troubleshooting section. |
| docs/platform/enterprise-platform/connect-a-client.mdx | Removes the older client connection page in favor of the new rollout-focused guidance. |
| docs/platform/enterprise-platform/configure-registry-server.mdx | Refocuses on enablement + Postgres wiring and moves migration failure guidance into troubleshooting <details>. |
| docs/platform/enterprise-platform/configure-identity.mdx | Tightens identity configuration narrative and improves step framing and wording. |
| docs/platform/enterprise-platform/configure-connector-gateway.mdx | Clarifies enablement requirements and updates links to the new rollout page; trims redundant explanation. |
| docs/platform/enterprise-platform/configure-ai-gateway.mdx | Clarifies enablement/bring-up ordering and replaces removed client-connection references with rollout guidance. |
| docs/platform/enterprise-platform/api-reference.mdx | Tightens API reference framing and clarifies what each API covers. |
| docs/platform/enterprise-platform/airgap-install.mdx | Streamlines air-gapped workflow description, improves structure, and adds <details> troubleshooting. |
| docs/platform/enterprise-manager/policies/telemetry.mdx | Simplifies telemetry policy guidance and reduces redundant rationale. |
| docs/platform/enterprise-manager/policies/registry.mdx | Simplifies registry policy guidance and removes repetitive framing. |
| docs/platform/enterprise-manager/policies/non-registry-servers.mdx | Tightens non-registry server policy description and enforcement guidance. |
| docs/platform/enterprise-manager/policies/index.mdx | Tightens enforcement-level explanation and improves “next steps” phrasing. |
| docs/platform/enterprise-manager/policies/ca-certificate.mdx | Clarifies directive purpose and shortens verbose explanations. |
| docs/platform/enterprise-manager/policies/build-env.mdx | Tightens directive purpose and clarifies enforced vs default usage. |
| docs/platform/enterprise-manager/intro.mdx | Tightens enforcement-level explanation and improves bootstrap description readability. |
| docs/platform/enterprise-manager/index.mdx | Simplifies “where to start” guidance and reduces list verbosity. |
| docs/platform/enterprise-manager/degraded-mode.mdx | Tightens degraded-mode definition and clarifies grace period behavior. |
| docs/platform/enterprise-directory/virtual-api-keys.mdx | Clarifies key purpose/ownership, updates client setup link to the new rollout page, and tightens rotation guidance. |
| docs/platform/enterprise-directory/users-and-groups.mdx | Tightens definitions and clarifies administration workflow and group alignment guidance. |
| docs/platform/enterprise-directory/scim-provisioning.mdx | Renames page title for task clarity and converts troubleshooting into <details> blocks. |
| docs/platform/enterprise-directory/managed-secrets.mdx | Tightens managed secret definition and improves KEK rotation explanation. |
| docs/platform/enterprise-directory/index.mdx | Tightens directory overview and clarifies which controls depend on directory vs token-claim groups. |
| docs/platform/enterprise-directory/identity-providers.mdx | Clarifies distinction between corporate IdP vs connector IdPs; tightens provider registration guidance. |
| docs/platform/enterprise-console/index.mdx | Refocuses console page toward administration use and adds <details> troubleshooting. |
| docs/platform/enterprise-cli/index.mdx | Tightens description of what the Stacklok CLI adds and clarifies policy impact framing. |
| docs/platform/enterprise-authz/quickstart-entra.mdx | Tightens quickstart framing and improves troubleshooting navigation and explanation clarity. |
| docs/platform/enterprise-authz/namespace-self-service.mdx | Retitles and reframes delegated authorization guidance and tightens boundaries/guardrails sections. |
| docs/platform/enterprise-authz/intro.mdx | Condenses and refocuses introduction to the CRD-based authorization model. |
| docs/platform/enterprise-authz/index.mdx | Tightens landing page copy and clarifies the delegation promise. |
| docs/platform/concepts/what-you-can-see.mdx | Removes the standalone “what you can see depends on what is installed” page per consolidation goal. |
| docs/platform/concepts/two-group-models.mdx | Retitles and restructures the “two group models” concept into a clearer comparison and alignment guidance. |
| docs/connector-gateway/tool-usage.mdx | Tightens tool usage screen explanation and reduces repetitive/verbose interpretation guidance. |
| docs/connector-gateway/index.mdx | Adds Enterprise callout and refocuses content on identity-aware tool endpoint + vMCP comparison. |
| docs/connector-gateway/connectors.mdx | Tightens connector definition, state model, and access grant explanation. |
| docs/ai-gateway/providers-and-models.mdx | Tightens provider definition/setup flow and clarifies constraints without over-explaining. |
| docs/ai-gateway/prompt-injection-screening.mdx | Tightens Bedrock Guardrails guidance and converts troubleshooting to <details>. |
| docs/ai-gateway/pci-pii-controls.mdx | Condenses explanation, clarifies tuning guidance, and tightens cache/security discussion. |
| docs/ai-gateway/model-routing.mdx | Tightens route/routing explanation and clarifies failover/retry relationship. |
| docs/ai-gateway/manage-budgets.mdx | Simplifies budgets screen guidance and clarifies defaults/priority behavior. |
| docs/ai-gateway/index.mdx | Adds Enterprise callout and refocuses intro on what the AI Gateway governs vs Connector Gateway. |
| docs/ai-gateway/forward-audit-logs.mdx | Tightens audit log explanation, clarifies schema notes, and reduces redundant “what it’s not” framing. |
| docs/ai-gateway/budgets-and-pricing.mdx | Tightens budgets/pricing explanation, clarifies enforcement prerequisites, and removes repetitive/negative restatement. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
danbarr
marked this pull request as ready for review
September 10, 2026 19:51
rdimitrov
approved these changes
Sep 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Perform a comprehensive editorial pass over the Stacklok Enterprise, AI Gateway, and Connector Gateway documentation introduced or restructured in #1145.
<details>blocksType of change
Related issues/PRs
Follow-up editorial pass for #1145.
Screenshots
Not applicable.
Submitter checklist
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed filesValidation
npm run prettier:fixnpm run eslint:fixgit diff --checknpm run buildThe build completes with the existing non-fatal HTML minifier warning for
/platform/enterprise-platform/api-reference.