Skip to content

Part 2: Update Registry Server docs for v1.0.0 and v1.0.1#683

Open
rdimitrov wants to merge 1 commit intoupdate-docs-toolhive-v0.17.0from
bump
Open

Part 2: Update Registry Server docs for v1.0.0 and v1.0.1#683
rdimitrov wants to merge 1 commit intoupdate-docs-toolhive-v0.17.0from
bump

Conversation

@rdimitrov
Copy link
Copy Markdown
Member

@rdimitrov rdimitrov commented Apr 9, 2026

Summary

Updates the Registry Server documentation to reflect the v1.0.0 and v1.0.1 releases, which introduced a new configuration model, claims-based authorization, and several new features.

Configuration model (v1.0.0)

  • Rewrite configuration.mdx for the new two-level config model: sources (data origins with sync/filter/claims) + registries (named API surfaces referencing sources)
  • Update all YAML examples across deploy-manual.mdx and related pages
  • Add DNS subdomain naming requirement for source names

Authorization (v1.0.0)

  • New authorization.mdx page covering RBAC roles (superAdmin, manageSources, manageRegistries, manageEntries), claims-based access control, claim containment logic, publish claim validation, admin API scoping, and a complete multi-tenant example
  • Add authz cross-references from authentication, configuration, deployment, intro, skills, and index pages
  • Add to sidebar between authentication and database

Per-entry Kubernetes claims (v1.0.1)

  • Replace removed claimMapping config with toolhive.stacklok.dev/authz-claims annotation documentation
  • Add authz-claims to the Kubernetes annotation table
  • Document that annotation claims replace (not merge with) source claims, and entries without the annotation have no claims
  • Document multiple Kubernetes sources support

Skills sync (v1.0.1)

  • Document that skills now sync from upstream-format Git, API, and File sources (not only managed sources)
  • Update intro, skills, and configuration pages

Other (v1.0.1)

  • Document GET /v1/me endpoint in authorization page
  • Fix broken #kubernetes-registry anchor in remote-mcp-proxy.mdx
  • Update stale Registry Server description in contributing.mdx
  • Fix terminology: "managed registry" → "managed source" where appropriate
  • Fix front matter descriptions (remove filler openers, trailing periods)
  • Fix heading capitalization and typos in deploy-operator.mdx

Changed files

File Change
guides-registry/authorization.mdx New — RBAC and claims-based authorization guide
guides-registry/configuration.mdx Major rewrite for sources/registries split, claims, K8s annotations
guides-registry/authentication.mdx Add authorization tip callout and forward link
guides-registry/intro.mdx Add authorization feature, fix terminology, skills sync mentions
guides-registry/skills.mdx Add claims section, skills sync from external sources
guides-registry/deploy-operator.mdx Fix heading, Next steps, typo, terminology
guides-registry/deploy-manual.mdx Update config example, add authorization link
guides-registry/deployment.mdx Add authorization link
guides-registry/index.mdx Add authorization link, fix description
sidebars.ts Add authorization page entry
guides-k8s/remote-mcp-proxy.mdx Fix broken anchor link
contributing.mdx Update stale Registry Server description

Test plan

  • Prettier formatting passes on all changed files
  • ESLint passes on all changed MDX files
  • Three rounds of docs-review skill with all issues addressed
  • Full-site audit for stale registry references (clean)
  • All factual claims verified against v1.0.1 source code (22/22 verified)
  • Verify site builds successfully (blocked by missing thv CLI in local env — CI will validate)

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings April 9, 2026 16:20
@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 9, 2026 10:44pm

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 initial documentation for Registry Server authorization and updates the Registry Server guide set to reflect the new “sources + registries” configuration model.

Changes:

  • Introduces a new Registry Server Authorization guide (RBAC + claims-based scoping).
  • Updates existing Registry Server docs to use sources/registries terminology and configuration examples.
  • Wires the new authorization page into navigation and cross-links it from related guides.

Reviewed changes

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

Show a summary per file
File Description
sidebars.ts Adds the new authorization doc to the Registry Server sidebar section.
docs/toolhive/guides-registry/skills.mdx Updates prerequisites/403 semantics and documents claims on skill publishing.
docs/toolhive/guides-registry/intro.mdx Refreshes intro terminology (“managed source”) and adds authorization as a feature.
docs/toolhive/guides-registry/index.mdx Updates landing page description and adds link to Authorization.
docs/toolhive/guides-registry/deployment.mdx Updates “next steps” to include authorization and new terminology.
docs/toolhive/guides-registry/deploy-operator.mdx Reworks wording around configuring sources and updates next-step links (incl. authz).
docs/toolhive/guides-registry/deploy-manual.mdx Updates the sample config to the new sources + registries structure.
docs/toolhive/guides-registry/configuration.mdx Major rewrite to document sources vs. registries, claims, and new examples.
docs/toolhive/guides-registry/authorization.mdx New page describing RBAC + claims model, configuration, and examples.
docs/toolhive/guides-registry/authentication.mdx Adds a callout and next-step link pointing readers to Authorization.

@rdimitrov rdimitrov changed the title Draft: Bootstrap registry v1 docs Update Registry Server docs for v1.0.0 and v1.0.1 Apr 9, 2026
@rdimitrov rdimitrov changed the base branch from main to update-docs-toolhive-v0.17.0 April 9, 2026 21:59
Restructure configuration docs to reflect the new two-level config
model (sources + registries), add a dedicated authorization guide
covering RBAC roles and claims-based access control, and update all
related pages for cross-document consistency.

Key changes:
- Rewrite configuration.mdx for sources/registries split
- Add authorization.mdx (roles, claims, /v1/me endpoint)
- Replace claimMapping with authz-claims annotation docs
- Document skills sync from external sources
- Document multiple Kubernetes sources support
- Add DNS subdomain naming requirement for source names
- Update cross-references across deployment, skills, and intro pages
- Fix broken anchor in remote-mcp-proxy.mdx

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@rdimitrov rdimitrov changed the title Update Registry Server docs for v1.0.0 and v1.0.1 Part 2: Update Registry Server docs for v1.0.0 and v1.0.1 Apr 9, 2026
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