docs: add demos, benchmarks, and four new user guide pages#30
Merged
Conversation
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
README.md(after Quick Start) listing all 24 notebooks indemo/grouped by category: Query Languages, Embedders, Vector Backends, and Features & Patterns.docs/demos.md— a dedicated index page for the demo notebooks with GitHub links, grouped by the same categories. Added as a top-level nav entry under Getting Started.docs/benchmarks.md— an index of all scripts inexperiments/grouped by topic (Latency, Throughput & Ingestion, Quality & Tuning, Cost & Observability, Dataset Generation). Added as a top-level nav entry under Getting Started.docs/user_guide/framework_integrations.md— full documentation for integrating Medha with LangChain (BaseCache), LlamaIndex (Workflow@step), and Haystack (@component), derived fromdemo/13_framework_integrations.ipynb.docs/user_guide/multi_tenancy.md— covers six multi-tenancy patterns (per-application isolation, per-customer isolation, shared embedder, concurrent fan-out, per-tenant stats, per-tenant backend selection), derived fromdemo/09_multi_tenant.ipynb.docs/user_guide/parameter_extraction.md— documents theParameterExtractorcascade (Regex → GLiNER → spaCy → Heuristics), with usage examples and a backend selection guide, derived fromdemo/05_ner_spacy_vs_gliner.ipynb.docs/user_guide/security.md— documents all security settings (max_question_length,max_file_size_mb,allowed_file_dir,qdrant_api_keyasSecretStr, PostgreSQL identifier validation) with a recommended production configuration.mkdocs.ymlnav accordingly: Getting Started is now a section with Overview / Demos / Benchmarks; four new pages added to the User Guide.Notes
No Python source changes. No new dependencies. All new pages link back to the corresponding notebook or script in the repository.