Skip to content

Add enterprise documentation constructs#716

Merged
danbarr merged 4 commits intomainfrom
enterprise-docs-components
Apr 15, 2026
Merged

Add enterprise documentation constructs#716
danbarr merged 4 commits intomainfrom
enterprise-docs-components

Conversation

@danbarr
Copy link
Copy Markdown
Collaborator

@danbarr danbarr commented Apr 14, 2026

Description

Three reusable constructs for presenting Stacklok Enterprise content inline with OSS documentation. All use a teal color palette that is distinct from the existing admonition types (blue/note, purple/info, green/tip, yellow/warning, red/danger) and works in both light and dark mode.

1. Enterprise admonition (:::enterprise)

Callout box for enterprise upsell content within OSS pages. Uses the Stacklok symbol as the icon. Supports custom titles via :::enterprise[My title].

:::enterprise

Stacklok Enterprise includes turnkey integrations for common
identity providers.

[Learn more about Stacklok Enterprise](/toolhive/enterprise).

:::
image image

2. Inline enterprise badge (<EnterpriseBadge />)

Lightweight inline label for tagging individual features or capabilities. Works next to headings, in lists, or inline with text.

### Session pinning <EnterpriseBadge />

- **Automatic failover** <EnterpriseBadge /> - connections are
  automatically rerouted when a node becomes unavailable.

image image

3. Sidebar ENT badge (className: 'enterprise-only')

Small "ENT" pill badge on sidebar navigation items that are exclusively enterprise. Applied via sidebar config, no component needed. Includes a tooltip on hover.

{
  type: 'doc',
  id: 'toolhive/guides-enterprise/config-server',
  className: 'enterprise-only',
}

image image

Hover state:
image image

Preview

All three constructs are demonstrated on the theme preview page in the Vercel preview deployment (/theme-preview#enterprise-constructs).

Type of change

  • New documentation

Related issues/PRs

Related to #714 (versioned docs spike) - these constructs are part of the enterprise documentation strategy described in the versioning strategy proposal.

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

danbarr and others added 2 commits April 14, 2026 15:56
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>
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>
Copilot AI review requested due to automatic review settings April 14, 2026 20:04
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Apr 14, 2026 8:18pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds reusable “Stacklok Enterprise” UI constructs to the Docusaurus docs site so enterprise-only content can be presented inline within OSS documentation (custom admonition, inline badge, and a sidebar ENT marker).

Changes:

  • Register a new :::enterprise admonition type with a custom Stacklok icon and teal styling.
  • Add an <EnterpriseBadge /> MDX component plus styling and ESLint MDX globals support.
  • Add CSS for an enterprise-only sidebar marker and document all constructs on the theme preview page.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
src/theme/MDXComponents.tsx Registers EnterpriseBadge as a global MDX component.
src/theme/Admonition/Types.tsx Introduces the enterprise admonition type and icon via theme swizzle.
src/css/custom.css Adds enterprise admonition palette + sidebar ENT badge/tooltip styles.
src/components/EnterpriseBadge/styles.module.css Styles the inline enterprise badge (light/dark).
src/components/EnterpriseBadge/index.tsx Adds the EnterpriseBadge component used in MDX.
eslint.config.mjs Allows EnterpriseBadge as a global in MDX linting.
docusaurus.config.ts Enables the enterprise admonition keyword in the docs plugin.
docs/theme-preview.mdx Demonstrates the new admonition/badge/sidebar marker in the theme preview page.

Comment thread src/css/custom.css
Comment thread src/css/custom.css Outdated
Comment thread src/components/EnterpriseBadge/index.tsx
Comment thread src/theme/Admonition/Types.tsx
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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>
@danbarr danbarr marked this pull request as ready for review April 15, 2026 16:15
@danbarr danbarr enabled auto-merge (squash) April 15, 2026 16:17
Copy link
Copy Markdown
Contributor

@Derek2Tu Derek2Tu left a comment

Choose a reason for hiding this comment

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

LGTM

@danbarr danbarr merged commit b640e71 into main Apr 15, 2026
3 checks passed
@danbarr danbarr deleted the enterprise-docs-components branch April 15, 2026 18:14
ChrisJBurns pushed a commit that referenced this pull request Apr 15, 2026
* 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>
yrobla pushed a commit that referenced this pull request Apr 16, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants