You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Add enterprise admonition and sidebar ENT badge
Custom :::enterprise admonition with Stacklok symbol icon and teal
color palette. Sidebar enterprise-only class with ENT pill badge
and hover tooltip. Examples on theme-preview page.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Add inline EnterpriseBadge component and reorganize theme preview
EnterpriseBadge component for labeling individual enterprise features
inline with text, headings, and lists. Enterprise constructs grouped
into their own section on the theme preview page. Removed sidebar
badge demo from the Enterprise page entry.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Show sidebar ENT tooltip on keyboard focus
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* Document enterprise constructs in CLAUDE.md and review skill
Add enterprise content constructs section to CLAUDE.md with usage
guidance for all three patterns. Update docs-review skill to check
for correct enterprise construct usage.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
-**Information flow**: Conceptual content (trade-offs, when to use) should come before implementation details, not after
53
53
-**Admonition weight**: Tips, notes, and warnings should be supplementary. If an admonition contains primary feature documentation (full YAML examples, the only explanation of a field or concept), it should be promoted to a proper section or its own page. A good test: if this admonition is the only place a feature is documented, it's not a tip - it's a section that needs a heading and ToC visibility.
54
+
-**Enterprise construct usage**: Three constructs exist for enterprise content - check they're used correctly. `:::enterprise` admonitions are for callout blocks (2-4 sentences, max 1-2 per page). `<EnterpriseBadge />` is for inline feature labels next to headings or list items. `className: 'enterprise-only'` in the sidebar is for enterprise-only pages. Flag misuse: enterprise admonitions used for single-feature labels (use `<EnterpriseBadge />` instead), badge used on entire page descriptions (use the admonition instead), or excessive enterprise admonitions on a single page.
54
55
-**Diataxis alignment**: Don't mix tutorials, how-tos, reference, and concepts in one doc without clear separation
Copy file name to clipboardExpand all lines: AGENTS.md
+37-1Lines changed: 37 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -263,7 +263,43 @@ This website is built using Docusaurus, which has some specific requirements and
263
263
- Titles are added using the `title="..."` attribute in the opening code fence.
264
264
- Line highlights are added using comma-separated `{number}` or `{start-end}` ranges in the opening code fence, or `highlight-next-line`, `highlight-start`, and `highlight-end` comments within the code block.
265
265
- Use admonitions for notes, tips, warnings, and other annotations. This provides a consistent look and feel across the site.
266
-
- Use the `:::type` syntax to define the admonition type: `note`, `tip`, `info`, `warning`, or `danger`. Use square brackets to add a custom title, e.g. `:::info[Title]`. Add empty lines around the start and end directives.
266
+
- Use the `:::type` syntax to define the admonition type: `note`, `tip`, `info`, `warning`, `danger`, or `enterprise`. Use square brackets to add a custom title, e.g. `:::info[Title]`. Add empty lines around the start and end directives.
267
+
- The `:::enterprise` admonition is for Stacklok Enterprise content only - see "Enterprise content constructs" below.
267
268
- Place images in `static/img` using WebP, PNG, or SVG format.
268
269
- Use the `ThemedImage` component to provide both light and dark mode screenshots for apps/UIs that support both. Typically used with the `useBaseUrl` hook to construct the image paths. Both require import statements.
269
270
- Use the `Tabs` and `TabItem` components to create tabbed content sections. These are in the global scope and do not require imports.
271
+
- Use the `EnterpriseBadge` component to label individual features or capabilities as enterprise-only. This is in the global scope and does not require imports. See "Enterprise content constructs" below.
272
+
273
+
### Enterprise content constructs
274
+
275
+
Three constructs are available for presenting Stacklok Enterprise content inline with OSS documentation. Use the right one for the context:
276
+
277
+
**`:::enterprise` admonition** - for callout content within OSS pages, typically 2-4 sentences describing an Enterprise capability with a link to the Enterprise landing page. Use when Enterprise adds a meaningful capability to the topic being documented. Don't overuse - one per page is typical, two is the practical maximum.
278
+
279
+
```mdx
280
+
:::enterprise
281
+
282
+
Stacklok Enterprise includes turnkey integrations for common identity providers. Instead of manually configuring OIDC, use the built-in Okta or Entra ID integration to map IdP groups directly to ToolHive roles and policy sets.
283
+
284
+
[Learn more about Stacklok Enterprise](/toolhive/enterprise).
285
+
286
+
:::
287
+
```
288
+
289
+
**`<EnterpriseBadge />`** - inline label for tagging individual features, capabilities, or configuration options as enterprise-only. Works next to headings, in lists, or inline with text. Use when a specific feature within a broader page is enterprise-only.
290
+
291
+
```mdx
292
+
### Session pinning <EnterpriseBadge />
293
+
294
+
-**Automatic failover** <EnterpriseBadge /> - connections are automatically rerouted when a node becomes unavailable.
295
+
```
296
+
297
+
**`className: 'enterprise-only'` sidebar badge** - for marking enterprise-only pages in the sidebar navigation. Applied in `sidebars.ts`, not in the page itself. Renders a small "ENT" pill badge with a tooltip on hover.
0 commit comments