Restructure docs: end-user README, developer CONTRIBUTING#95
Open
adityamparikh wants to merge 7 commits into
Open
Restructure docs: end-user README, developer CONTRIBUTING#95adityamparikh wants to merge 7 commits into
adityamparikh wants to merge 7 commits into
Conversation
This was referenced Apr 24, 2026
README.md: Rewritten for end users with: - Natural language intro showing the value proposition - Features table with all MCP tools and resources - Quick Start guide (Docker + Claude Desktop in 2 minutes) - Per-client setup with collapsible sections (Claude Desktop, Claude Code, VS Code, Cursor, JetBrains, MCP Inspector) - Configuration reference (environment variables) - Example prompts by category - Community links (website, Slack, mailing lists) CONTRIBUTING.md: Updated with: - Security setup links (Auth0, Keycloak) - Community channels (Slack, issues, discussions, mailing lists) - Apache Code of Conduct reference Signed-off-by: Aditya Parikh <adityamparikh@gmail.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
Reorder all client configs to show JAR setup first (ATR release path) and local Docker images second. Remove all ghcr.io references — use solr-mcp:latest built locally via ./gradlew jibDockerBuild. Signed-off-by: Aditya Parikh <adityamparikh@gmail.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
Content covered by the observability page on the website (solr.apache.org/mcp/observability.html). Signed-off-by: Aditya Parikh <adityamparikh@gmail.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
Move dev-docs/ and security-docs/ into docs/development/ for a
single organized docs structure:
docs/
development/ (ARCHITECTURE, DEVELOPMENT, DEPLOYMENT, etc.)
specs/ (graalvm-native-image)
Fix CONTRIBUTING.md to use clickable markdown links instead of
plain text paths. Update all cross-references in WORKFLOWS.md.
Signed-off-by: Aditya Parikh <adityamparikh@gmail.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
Signed-off-by: Aditya Parikh <adityamparikh@gmail.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
Link to Apache License 2.0 URL instead of non-existent file. Signed-off-by: Aditya Parikh <adityamparikh@gmail.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
adityamparikh
force-pushed
the
docs-restructure
branch
from
064db71 to
5043cff
Compare
Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com> # Conflicts: # README.md
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
1 participant
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
Restructures documentation to serve two distinct audiences:
README.md -- rewritten for end users who want to use the MCP server:
CONTRIBUTING.md -- updated for developers:
Companion to apache/solr-site#174 (website with full documentation).
Supersedes #94.
Test plan
🤖 Generated with Claude Code