docs: restructure documentation for better discoverability #302
+779
−789
Conversation
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
Reorganize documentation following progressive disclosure principles: - Trim README from 515 lines to ~95 lines (~82% reduction) - Create docs/index.md as documentation hub - Create docs/getting-started.md for container consumers - Create docs/adding-servers.md consolidating contribution guides - Create docs/security.md for security overview - Delete docs/packaging.md (merged into adding-servers.md) - Update CONTRIBUTING.md to be Dockyard-specific (was ToolHive) Documentation is now organized by user journey: - Container users -> getting-started.md - MCP server authors -> adding-servers.md - Security teams -> security.md, attestations.md, provenance.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
rdimitrov
approved these changes
Jan 20, 2026
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.
Summary
docs/index.mdas documentation hub with user journeysdocs/getting-started.mdfor container consumersdocs/adding-servers.mdconsolidating contribution guidesdocs/security.mdfor security overviewdocs/packaging.md(merged into adding-servers.md)CONTRIBUTING.mdto be Dockyard-specific (was referencing ToolHive)Motivation
The README was overwhelming at 515 lines, trying to serve all audiences at once. This restructure follows progressive disclosure principles:
Test plan
🤖 Generated with Claude Code