Skip to content

Move reference docs in-situ, restore client compatibility to top level#583

Merged
danbarr merged 4 commits intomainfrom
revert-reference-sidebar
Mar 4, 2026
Merged

Move reference docs in-situ, restore client compatibility to top level#583
danbarr merged 4 commits intomainfrom
revert-reference-sidebar

Conversation

@danbarr
Copy link
Collaborator

@danbarr danbarr commented Mar 4, 2026

Description

Removes the standalone "Reference" sidebar section added in #551 in favour of placing reference docs where users naturally expect to find them.

  • Registry schemas moved into the Registry Server section (after the registry API), with the upstream schema listed first as the toolhive schema is being phased out
  • client-compatibility restored as a top-level sidebar item — it's cross-cutting and relevant to all deployment paths
  • Eliminates the Docusaurus dual-link problem where opening a doc from one section expands the other section too

Type of change

  • Navigation/structure change

Submitter checklist

Content and formatting

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

Navigation

  • Sidebar navigation (sidebars.ts) updated for added, deleted, reordered, or renamed files
  • Redirects added to vercel.json for moved, renamed, or deleted pages — N/A, no URLs changed

Copilot AI review requested due to automatic review settings March 4, 2026 16:13
@vercel
Copy link

vercel bot commented Mar 4, 2026

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

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Mar 4, 2026 4:43pm

Request Review

Copy link
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

This PR updates the ToolHive Docusaurus sidebar information architecture by eliminating the standalone “Reference” section and instead placing reference docs within the product sections where they’re most relevant, while keeping client compatibility as a cross-cutting top-level entry.

Changes:

  • Moves registry schema reference docs into the “Registry Server” section immediately after the registry API doc.
  • Restores client-compatibility as a top-level sidebar item (removing it from the deleted “Reference” category).
  • Removes the “Reference” sidebar category (and its generated index) to avoid the dual-link sidebar expansion behavior.

You can also share your feedback on Copilot code review. Take the survey.

danbarr added 2 commits March 4, 2026 11:41
Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
@danbarr danbarr merged commit 0e9c80b into main Mar 4, 2026
4 checks passed
@danbarr danbarr deleted the revert-reference-sidebar branch March 4, 2026 17:13
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