Skip to content

Update docs for ToolHive v0.16.0#687

Open
reyortiz3 wants to merge 3 commits intomainfrom
update-docs-v0.16.0
Open

Update docs for ToolHive v0.16.0#687
reyortiz3 wants to merge 3 commits intomainfrom
update-docs-v0.16.0

Conversation

@reyortiz3
Copy link
Copy Markdown

Description

This PR updates the user-facing documentation to reflect the non-reference
changes in ToolHive v0.16.0. Reference docs (CLI commands, CRD spec, API spec)
were already updated automatically in #678.

Type of change

  • Documentation update

Changes

thv skill builds / thv skill builds remove (guides-cli/skills-management.mdx)

  • Added a new section "List and remove locally-built skill artifacts" covering
    thv skill builds (list) and thv skill builds remove <tag> (remove), with
    example output and a link to the CLI reference.

MCPOIDCConfig VALID column (guides-k8s/auth-k8s.mdx)

  • Corrected the status column name from READY to VALID. This was a breaking
    change in v0.16.0: the condition type was renamed for consistency with the
    other config CRDs.

MCPServerEntry CRD (guides-k8s/intro.mdx)

  • Added MCPServerEntry to the workload resource table and updated the
    introductory prose to mention the new CRD type.
  • Added a note clarifying that the CRD is available in v0.16.0 but the
    reconciliation controller ships in a future release.

VirtualMCPServer Redis session storage (guides-vmcp/scaling-and-performance.mdx)

  • Updated the session storage section to clarify that Redis enables cross-pod
    session restore and sessions survive pod restarts (new capability in v0.16.0
    via PR #4479 upstream).

Related issues/PRs

Submitter checklist

Content and formatting

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

🤖 Generated with Claude Code

- Add thv skill builds and thv skill builds remove guide content to
  skills-management.mdx with example output and CLI reference link
- Fix MCPOIDCConfig status column name READY → VALID in auth-k8s.mdx
  (breaking change in v0.16.0: condition type renamed for consistency)
- Document MCPServerEntry CRD in K8s intro with note that controller
  ships in a future release
- Clarify VirtualMCPServer Redis session storage enables cross-pod
  restore and survives pod restarts

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 9, 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 10, 2026 5:16pm

Request Review

Copy link
Copy Markdown
Collaborator

@danbarr danbarr left a comment

Choose a reason for hiding this comment

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

The thv skill builds section and the READYVALID fix look good. Two things to address:

Cut MCPServerEntry until the controller ships (see inline comment)

Redundant paragraph in Redis session storage section

In scaling-and-performance.mdx, the updated opening sentence already covers the new capability ("sessions are shared across pods and survive pod restarts"), and the "without" sentence reinforces it from the negative side. The added paragraph ("With Redis session storage configured, vMCP stores session state in Redis so that any replica can resume a session, even after a pod restart or failover.") restates the same point. Cut it.

Also, the lint/formatting checks are failing and will need to be addressed. Pre-commit hook should have taken care of this if you have nodejs installed (or use the devcontainer).

Comment on lines +85 to +94
:::note

`MCPServerEntry` is a new resource type added in v0.16.0. The CRD is available
and you can create resources, but the reconciliation controller ships in a
future release. Creating `MCPServerEntry` resources before the controller is
available has no effect — the operator will not reconcile them until the
controller ships.

:::

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

So why even document it at this point? Hold off until it's ready to use?


- [Understanding skills](../concepts/skills.mdx) for a conceptual overview
- [`thv skill` command reference](../reference/cli/thv_skill.md)
- [`thv skill builds` command reference](../reference/cli/thv_skill_builds.md)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

No need to add a specific subcommand reference, it's covered by the one above and none of the others are individually linked.

Suggested change
- [`thv skill builds` command reference](../reference/cli/thv_skill_builds.md)

Comment on lines +319 to +321
TAG DIGEST NAME VERSION
ghcr.io/my-org/skills/my-skill:v1.0.0 sha256:a1b2c3d4... my-skill 1.0.0
my-skill:latest sha256:e5f6a7b8... my-skill
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Alignment issue?

Suggested change
TAG DIGEST NAME VERSION
ghcr.io/my-org/skills/my-skill:v1.0.0 sha256:a1b2c3d4... my-skill 1.0.0
my-skill:latest sha256:e5f6a7b8... my-skill
TAG DIGEST NAME VERSION
ghcr.io/my-org/skills/my-skill:v1.0.0 sha256:a1b2c3d4... my-skill 1.0.0
my-skill:latest sha256:e5f6a7b8... my-skill

@reyortiz3
Copy link
Copy Markdown
Author

@claude are all the comments addressed?

@claude
Copy link
Copy Markdown
Contributor

claude bot commented Apr 10, 2026

Claude finished @reyortiz3's task in 1m 11s —— View job


Review comment status

Here's the status of each review comment from @danbarr:

# Comment Status
1 Cut MCPServerEntry until the controller ships (intro.mdx) ❌ Not addressed
2 Remove redundant paragraph in scaling-and-performance.mdx ❌ Not addressed
3 Remove thv skill builds specific subcommand reference (skills-management.mdx:359) ❌ Not addressed
4 Fix alignment in output example (skills-management.mdx:321) ❌ Not addressed
5 Fix lint/formatting failures ❓ Unknown (CI status not checked)

Details

1. Cut MCPServerEntry — The MCPServerEntry row was added to the resource type table (line 79) and a note admonition was added (lines 85–93) explaining the controller ships in a future release. The reviewer explicitly asked to hold off on documenting it at all ("So why even document it at this point?"). Both the table row and the note need to be removed.

2. Redundant paragraph in scaling-and-performance.mdx — Lines 74–75 still contain the paragraph:

"With Redis session storage configured, vMCP stores session state in Redis so that any replica can resume a session, even after a pod restart or failover."

This needs to be removed since the opening sentence (lines 69–72) already covers the same information.

3. thv skill builds subcommand reference — Line 359 still has:

- [`thv skill builds` command reference](../reference/cli/thv_skill_builds.md)

The suggestion was to remove it (empty suggestion block = deletion).

4. Alignment issue — The first data row in the builds output example is still misaligned. The tag ghcr.io/my-org/skills/my-skill:v1.0.0 (38 chars) needs one more space before sha256:... to align with the DIGEST column header.


None of the four inline/review comments appear to have been addressed yet in the current branch state.

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.

2 participants