Revamp README and docs for the Query Engine era#4
Open
C0staTin wants to merge 1 commit into
Open
Conversation
- 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>
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
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
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
docs/index.html — cleanup + SEO
docs/og-image.png(1200×630) matching the docs theme;og:imagepoints at https://mindsdb.github.io/engine/og-image.pngCommunity surfaces
Notes for reviewers
docs/dark_mode.htmlintentionally untouched (pending a team check on whether anyone uses it)🤖 Generated with Claude Code