Skip to content

Revamp README and docs for the Query Engine era#4

Open
C0staTin wants to merge 1 commit into
mainfrom
revamp-readme-docs-seo
Open

Revamp README and docs for the Query Engine era#4
C0staTin wants to merge 1 commit into
mainfrom
revamp-readme-docs-seo

Conversation

@C0staTin

@C0staTin C0staTin commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Brings the repo's front door in line with the new MindsDB/MindsHub reality and the new docs at https://mindsdb.github.io/engine.

README.md — full rewrite, developer-first

  • Plain-text header ("Semantic search over all your data — entirely in SQL"), accurate badges, nav line: Docs · Website · Discord · Contact
  • "Where this fits" note: the Query Engine is a standalone open-source project that optionally pairs with MindsHub agents; links the MindsHub vs MindsDB story
  • Technical "How it works" (wire protocols, federated planner, knowledge bases, hybrid retrieval, jobs) with an ASCII architecture diagram
  • "From zero to semantic search": 6-step SQL walkthrough mirroring the docs syntax, with deep links to docs anchors and the semantic-search explainer video
  • Removed: old header image, demo gif, DeepWiki badge, tutorials (dead blog links), Slack, contributor rewards, contributors graph (pulled from the repurposed mindsdb/mindsdb repo), agents examples, all docs.mindsdb.com/mindsdb.com links

docs/index.html — cleanup + SEO

  • Removed the MindsDB Cloud section and sidebar entry (cloud.mindsdb.com is unreachable)
  • Title sharpened to "MindsDB Query Engine — SQL Reference"
  • Added meta description, canonical, robots, theme-color, Open Graph + Twitter card tags, JSON-LD; kept the Google site-verification tag
  • New docs/og-image.png (1200×630) matching the docs theme; og:image points at https://mindsdb.github.io/engine/og-image.png

Community surfaces

  • CONTRIBUTING.md: issues link → this repo, Slack/newsletter removed, Discord added, Code of Conduct → local file
  • Issue templates: contact link → Discord; deleted the ended integrations-contest template

Notes for reviewers

  • The og:image/canonical URLs take effect once this lands and GitHub Pages redeploys
  • docs/dark_mode.html intentionally untouched (pending a team check on whether anyone uses it)

🤖 Generated with Claude Code

- Rewrite README as a developer-first intro to the Query Engine:
  technical How-it-works with architecture diagram, zero-to-semantic-
  search SQL walkthrough aligned with the new docs syntax, and links
  migrated from mindsdb.com/docs.mindsdb.com to mindshub.ai and
  mindsdb.github.io/engine
- Position the engine as a standalone open-source project that
  optionally pairs with MindsHub agents
- Remove outdated content: header image, demo gif, DeepWiki badge,
  tutorials, Slack links, contributor rewards, contributors graph,
  agents examples
- docs: drop the MindsDB Cloud setup section, sharpen the page title,
  add SEO meta (description, canonical, robots, Open Graph, Twitter
  card, JSON-LD) and a 1200x630 og-image.png
- Update CONTRIBUTING.md and issue-template contact link to Discord
  and the engine repo; delete the ended integrations-contest template

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.

1 participant