docs: Mintlify documentation site - #17
Merged
Merged
Conversation
Convert docs/ into a self-contained Mintlify site and migrate the existing Markdown docs into it. - Add docs.json (theme, nav, brand color, GitHub/Discord links) plus favicon and logo assets. - Author MDX pages: landing, quickstart, concepts, use-cases, guides (creating a brain, populating entities, entity management, search configuration), agents (MCP context layer, connectors), deployment, and a full CLI reference. - Migrate docs/configuration.md -> docs/guides/search-configuration.mdx, docs/deployment.md -> docs/deployment.mdx, entity-management.md and cookbooks.md into the site. - Repoint references in README, docker-compose.yml, ui/app.py, and the cloud-brain example to the new doc paths. Co-Authored-By: Claude Opus 4.8 (1M context) <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
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.
What
Turns
docs/into a self-contained Mintlify documentation site and migrates every existing Markdown doc into it.Added
docs/docs.json— Mintlify config (theme, grouped nav, brand color, GitHub/Discord links)docs/favicon.svg,docs/logo/{light,dark}.svgdocs/README.md— how to preview (mint dev) and deployMigrated (content preserved)
docs/configuration.md→docs/guides/search-configuration.mdxdocs/deployment.md→docs/deployment.mdxentity-management.md→docs/guides/entity-management.mdxcookbooks.md→docs/use-cases.mdxRepointed references
docker-compose.yml,open_index/ui/app.py,examples/cloud-brain/tools_server.pyVerification
docs.jsonis valid JSON; every internal link (href=and inline](/...)) resolves to an existing page.mint dev) under Node 22 — server responds HTTP 200, title "Open Index", all pages render.Deploy
Connect this repo in the Mintlify dashboard with root directory
docs; pushes to the default branch publish automatically.🤖 Generated with Claude Code