Draft
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Spike to validate a Docusaurus docs-versioning approach that keeps OSS docs on the rolling “current” version while serving pinned Enterprise snapshots under /enterprise/<version>/....
Changes:
- Adds Docusaurus
versionsconfiguration (Enterprise 1.0/1.1) and a navbar version dropdown. - Introduces a large set of
versioned_docs/version-1.0/...pages to represent an Enterprise snapshot. - Updates ESLint config to lint MDX partials under
versioned_docs/as well asdocs/.
Reviewed changes
Copilot reviewed 67 out of 441 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-1.0/toolhive/guides-mcp/k8s.mdx | Adds versioned Kubernetes MCP server guide content for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-mcp/grafana.mdx | Adds versioned Grafana MCP server guide content for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-mcp/github.mdx | Adds versioned GitHub MCP server guide content for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-mcp/filesystem.mdx | Adds versioned Filesystem MCP server guide content for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-mcp/fetch.mdx | Adds versioned Fetch MCP server guide content for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-mcp/context7.mdx | Adds versioned Context7 MCP server guide content for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-mcp/_template.mdx | Adds an MCP guide template into the versioned docs tree. |
| versioned_docs/version-1.0/toolhive/guides-k8s/token-exchange-k8s.mdx | Adds versioned Kubernetes token exchange guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-k8s/telemetry-and-metrics.mdx | Adds versioned Kubernetes telemetry/metrics guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-k8s/rate-limiting.mdx | Adds versioned Kubernetes rate limiting guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-k8s/intro.mdx | Adds versioned Kubernetes guides overview page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-k8s/index.mdx | Adds versioned Kubernetes guides index card list for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-k8s/customize-tools.mdx | Adds versioned Kubernetes tool customization guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/token-exchange.mdx | Adds versioned CLI token exchange guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/thvignore.mdx | Adds versioned .thvignore guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/test-mcp-servers.mdx | Adds versioned “test MCP servers” guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/secrets-management.mdx | Adds versioned secrets management guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/quickstart.mdx | Adds versioned CLI quickstart guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/network-isolation.mdx | Adds versioned network isolation guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/manage-mcp-servers.mdx | Adds versioned server management guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/index.mdx | Adds versioned CLI guides index card list for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/group-management.mdx | Adds versioned group management guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/filesystem-access.mdx | Adds versioned filesystem access guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/custom-permissions.mdx | Adds versioned custom permissions guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/client-configuration.mdx | Adds versioned client configuration guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/auth.mdx | Adds versioned CLI auth guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/api-server.mdx | Adds versioned CLI API server guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/guides-cli/advanced-cicd.mdx | Adds versioned CI/CD patterns guide for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/faq.mdx | Adds versioned FAQ for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/enterprise.mdx | Adds versioned Enterprise marketing/CTA page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/contributing.mdx | Adds versioned contributing overview for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/concepts/vmcp.mdx | Adds versioned vMCP concept page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/concepts/tool-optimization.mdx | Adds versioned tool optimization concept page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/concepts/skills.mdx | Adds versioned skills concept page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/concepts/registry-criteria.mdx | Adds versioned registry criteria concept page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/concepts/mcp-primer.mdx | Adds versioned MCP primer concept page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/concepts/groups.mdx | Adds versioned groups concept page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/concepts/embedded-auth-server.mdx | Adds versioned embedded auth server concept page for Enterprise v1.0 snapshot. |
| versioned_docs/version-1.0/toolhive/_partials/_remote-mcp-auth-examples.mdx | Adds versioned remote MCP auth examples partial. |
| versioned_docs/version-1.0/toolhive/_partials/_oidc-prerequisites.mdx | Adds versioned OIDC prerequisites partial. |
| versioned_docs/version-1.0/toolhive/_partials/_client-config-intro.mdx | Adds versioned client config intro partial. |
| versioned_docs/version-1.0/toolhive/_partials/_basic-cedar-config.mdx | Adds versioned basic Cedar config partial. |
| versioned_docs/version-1.0/toolhive/_partials/_auth-troubleshooting.mdx | Adds versioned auth troubleshooting partial. |
| versioned_docs/version-1.0/theme-preview.mdx | Adds a theme preview page into the versioned docs tree. |
| proposals/docs-versioning-strategy.md | Adds the written proposal explaining the versioning strategy. |
| eslint.config.mjs | Extends MDX partial linting rules to versioned_docs/**/_partials/*.mdx. |
| docusaurus.config.ts | Adds Docusaurus docs version configuration and a docs version dropdown in the navbar. |
2 tasks
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
Spike to validate the Docusaurus versioning approach proposed for Stacklok Enterprise documentation. This is a preview for discussion - not intended to merge as-is.
The proposals in this branch describe a versioning strategy where Enterprise customers get pinned, version-accurate docs while OSS docs remain on a rolling latest. See:
What to look at
Browse all three versions using the version dropdown in the top-right navbar in the Vercel preview:
/toolhive/.../enterprise/1.1/toolhive/.../enterprise/1.0/toolhive/...Things to note when clicking around:
Key decisions validated in this spike
lastVersion: 'current'keeps OSS docs at root path, unchangedpath: 'enterprise/<version>'gives Enterprise versions a clean URL prefixbanner: 'none'suppresses the default "old version" warningnoIndex: trueprevents SEO dilution from versioned pagesdocs:versionruns (Docusaurus validates againstversions.jsonat startup)docsVersionDropdownnavbar item provides the version pickerType of change
Related issues/PRs
None - spike for internal discussion.
Submitter checklist
Content and formatting
I have reviewed the content for spelling, grammar, and style(spike only)