Documentation: Relocate content from README into individual pages

[amotl]

About

Relocate content from README into individual pages.

Preview

Rendering.

Summary by CodeRabbit

• Documentation
  • Added comprehensive installation guides covering package, integration, OCI, and MCPO deployment options
  • Added configuration documentation for environment variables, transport modes, and security settings
  • Added integration guides for popular AI assistants and tools
  • Added usage documentation for connecting to the MCP server
  • Updated README with reorganized, streamlined content
  • Added reference resource links collection

[coderabbitai]

Warning

Rate limit exceeded

@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between cb40789 and 92162ff.

📒 Files selected for processing (10)

• README.md (3 hunks)
• docs/_links.md (1 hunks)
• docs/configure/index.md (1 hunks)
• docs/index.md (1 hunks)
• docs/install/index.md (1 hunks)
• docs/install/integrate.md (1 hunks)
• docs/install/mcpo.md (1 hunks)
• docs/install/oci.md (1 hunks)
• docs/install/package.md (1 hunks)
• docs/usage/index.md (1 hunks)

Walkthrough

Documentation restructuring and expansion including README reorganization, new hyperlink references, and comprehensive guides for installation, configuration, integration, and usage of CrateDB MCP across multiple documentation pages.

Changes

Cohort / File(s)	Change Summary
README restructuring README.md	Reorganizes content, removes Introduction header and extensive MCP documentation blocks, updates navigation links (adds CrateDB Handbook, removes Bluesky), consolidates toward leaner project information
Documentation reference links docs/_links.md	Adds 21 new Markdown hyperlinks for MCP servers, tooling, integration examples, documentation pages, and related resources
Core documentation pages docs/index.md, docs/configure/index.md	Adds comprehensive documentation with Quickstart guide, quick-access cards (Install, Configure, Use), tool overview (Text-to-SQL, Documentation server, Health inquiry), and detailed configuration guidance for cluster URLs, timers, caching, transport modes, security, and system prompts
Installation guides docs/install/index.md, docs/install/package.md, docs/install/integrate.md, docs/install/oci.md, docs/install/mcpo.md	Introduces multi-option installation documentation covering package manager setup (uv/uvx), AI assistant integrations (Claude, Cline, Cursor, Roo Code, Windsurf, VS Code, Goose, LibreChat), OCI container deployment, and MCPO image configuration with example commands and environment variable guidance
Usage documentation docs/usage/index.md	Documents connecting to MCP server with various clients, example questions, standalone operation, and transport configuration options (stdio, sse, http)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• README.md: Verify reorganization maintains logical flow and all critical links remain intact
• docs/install/integrate.md: Cross-check JSON/YAML configuration snippets for accuracy across multiple AI tools (Claude, Cline, Cursor, etc.)
• docs/configure/index.md and docs/install/oci.md: Validate technical details (environment variables, Docker commands, transport modes) for correctness
• docs/_links.md: Ensure all 21 new hyperlinks are properly formatted and point to intended resources

Possibly related PRs

• Documentation: Educate about CRATEDB_MCP_HTTP_TIMEOUT environment variable #20: Documents CRATEDB_MCP_HTTP_TIMEOUT configuration that was implemented in that PR's code changes
• Prompt: Enable user-defined instructions #57: Documents system prompt customization (show-prompt, conventions, instructions) features added in that PR
• OCI: Add building OCI images cratedb-mcp and cratedb-mcpo #50: Overlaps with OCI documentation and image references in README and installation guides

Suggested reviewers

• kneth
• surister
• joncombe

Poem

🐰 Hops through the docs with glee and might,
New guides and configs, shining bright!
Links and integration all in place,
Install, configure—what a pace!
The CrateDB warren now complete ✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "Documentation: Relocate content from README into individual pages" directly aligns with the primary changes in the changeset. The README.md is being reorganized and trimmed, with extensive sections (Introduction header, large MCP documentation blocks, Quickstart/Install sections) being removed. Simultaneously, multiple new documentation pages are being created under docs/ (configure/index.md, install/index.md, install/integrate.md, install/oci.md, install/package.md, install/mcpo.md, usage/index.md), which is consistent with the stated objective of relocating content from README into individual pages. The title is concise, specific, and clearly communicates the primary change without vague terminology.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}