Mohd Kaif
a326c7d3bd
Fix/mintlify theme ( #645 )
...
* fix: replace invalid Mintlify theme 'venus' with 'mint'
* docs: replace em dashes with colons across all docs files
* fix: strip UTF-8 BOM from all docs files (broke frontmatter detection)
2026-06-17 13:26:19 +05:30
Mohd Kaif
1f3cea5f0a
docs: upgrade all docs pages with Mintlify premium components ( #642 )
...
Replace plain markdown lists, tables, and numbered steps with interactive
Mintlify v3 MDX components across all 50+ documentation files:
- Tabs: provider/parser/method selection guides, citation formats, component details
- Steps: setup flows, pipeline stages, connection initialization
- CardGroup/Card: feature overviews, "what you get" sections, navigation footers
- AccordionGroup: FAQ entries
- Check/Warning/Tip/Note/Info: callouts replacing plain bold text and inline notes
Files improved span the full docs surface: reference modules (context, llms,
kg, reasoning, embeddings, deduplication, provenance, parse, ontology, core,
semantic_extract), integrations (agno, docling, snowflake), graph/vector
store backends (apache_age, pgvector), and top-level guides (contributing,
governance, glossary, citation, community-projects, learning-more).
2026-06-17 12:58:44 +05:30
Sameer6305
05ff590212
docs(vector_store): align vector store docs with implementation
2026-06-16 11:18:18 +05:30
Mohd Kaif
5d70d0c10d
docs: replace Exported Classes import blocks with summary tables (all 25 modules) ( #567 )
...
* docs: replace Exported Classes import blocks with summary tables across all 25 modules
* docs: add method/parameter tables to parse, ingest, ontology, normalize, triplet_store, change_management, conflicts, export, graph_store, provenance, and semantic_extract modules
2026-05-24 15:49:58 +05:30
KaifAhmad1
68fcff5b3a
docs: add Exported Classes blocks to all remaining reference docs
...
Adds ## Exported Classes (or equivalent interface block) to:
- change_management.md, conflicts.md, context.md, embeddings.md
- graph_store.md, ingest.md, normalize.md, pipeline.md
- seed.md, split.md, triplet_store.md, vector_store.md
- visualization.md
Adds ## Launch Interface to explorer.md (CLI-only module).
Adds ## Server Interface to mcp_server.md (stdio process, not importable).
All blocks sourced from module __all__ with inline usage hints.
evals.md intentionally skipped (placeholder, __all__ = []).
2026-05-24 14:56:11 +05:30
KaifAhmad1
ff43887842
fix: correct remaining API mismatches in pipeline, vector_store, and normalize docs
...
- pipeline.md: ParallelismManager pool_type="thread"/"process" → use_processes=False/True;
execute_parallel() returns List[ParallelExecutionResult] not aggregate object
- vector_store.md: remove MetadataStore.add_field() (method is on MetadataSchema, not
MetadataStore); fix tip to reference MetadataStore.update_metadata() not VectorStore
- normalize.md: Pipeline() orchestrator misuse → PipelineBuilder + ExecutionEngine pattern
2026-05-24 13:14:01 +05:30
KaifAhmad1
689d57b361
fix: correct API mismatches in pipeline, ingest, and vector_store docs
...
pipeline.md:
- Replace Pipeline().add_step().run() with PipelineBuilder + ExecutionEngine.execute_pipeline()
- Fix ValidationResult: result.valid (not is_valid), errors is List[str] not object list
- Fix ExecutionResult schema: success/output/metadata/metrics/errors (not PipelineResult)
- Fix ExecutionEngine: get_pipeline_status() not get_status(), progress keys completed_steps/total_steps
- Fix result.metadata['pipeline_id'] not result.pipeline_id
- Fix RetryPolicy: strategy=RetryStrategy.EXPONENTIAL not backoff='exponential'
- Fix PipelineSerializer.serialize_pipeline/deserialize_pipeline instead of pipeline.save/load
- Fix delta mode to use PipelineBuilder not Pipeline()
ingest.md:
- Replace S3Ingestor/GCSIngestor/GDriveIngestor (do not exist) with CloudStorageIngestor
- Remove MongoIngestor/DuckDBIngestor (do not exist) from docs and tables
- Fix Quick Start pipeline step to use PipelineBuilder + ExecutionEngine
vector_store.md:
- Replace store.hybrid_search() (does not exist) with HybridSearch.search()
- Replace store.add_vectors() with store.add_documents() / store.store_vectors()
- Replace store.search(query_vector) with store.search_vectors(k=) / store.search(query_str, limit=)
- Fix Batch Operations: add_vectors_batch -> add_documents, delete_vectors(vector_ids=), update_vectors()
- Fix HybridSearch.search() signature: (query, k, metadata_filter) not (query_vector, query_text, fusion, filters)
- Fix MetadataStore: store_metadata/get_metadata/update_metadata/query_metadata (not add/filter/get)
- Fix NamespaceManager: add_vector_to_namespace, list_namespaces returns List[str]
2026-05-24 12:36:21 +05:30
KaifAhmad1
5eefadaa7f
docs: apply full Mintlify component overhaul to all 27 reference pages and concepts.md
...
Replace plain markdown in every docs/reference/ file and docs/concepts.md with
rich Mintlify JSX components — CardGroup, Steps, Tabs, AccordionGroup, Tip,
Warning, Note, and CodeGroup — for a consistent, navigable, production-grade
developer experience.
2026-05-23 23:02:03 +05:30
KaifAhmad1
9113ef3428
docs: premium overhaul of all reference pages and core docs
...
- Rewrote all 26 reference module pages: removed blockquote taglines and
horizontal rule separators, added "What You Get" bullet summaries,
added constructor/method parameter tables, expanded thin files
(graph_store, triplet_store, visualization, provenance) with full API
coverage, added backend comparison tables and real-world usage patterns
- Renamed Modules tab from "API Reference" and group from "Context &
Knowledge" to "Context & Intelligence" in docs.json
- Fixed logo: copied "Semantica Logo.png" to web-safe semantica-logo.png
and updated all 4 references in docs.json
- Improved core docs (index, modules, concepts, quickstart, installation,
getting-started) with better fonts, bullet points, and complete module
listings (mcp_server, evals, core, utils previously missing)
- Rewrote community pages (community, community-projects, contributing-guide,
use-cases, architecture, faq, learning-more, glossary) with heading
hierarchy fixes, expanded definitions, and better structure
- Fixed markdown linter warnings: MD036 bold-as-heading, MD001 heading
skips, MD040 missing code fence language, MD032 blank lines around lists
2026-05-23 13:10:09 +05:30
KaifAhmad1 and Claude Sonnet 4.6
946a1089c8
docs: premium redesign — Mintlify v4, dark/cream theme, full module coverage
...
- Migrate from mint.json to docs.json (Mintlify v4)
- Theme: maple, emerald green + near-black dark / cream light palette
(#059669 primary, #0A0A0A dark bg, #FAF7F0 light bg)
- Typography: Lexend headings, Inter body
- 5-tab navigation: Documentation, Quick Start, API Reference, Cookbook, FAQ
- Homepage: removed badge stickers, redundant h2, added blockquote tagline,
full 27-module reference table with semantica.mcp_server added
- quickstart.md: CodeGroup per pipeline step, pattern vs LLM options,
AccordionGroup for patterns and troubleshooting
- faq.md: full AccordionGroup structure across 5 sections
- reference/explorer.md: NEW — FastAPI explorer, Ontology Hub, Distance
Intelligence, CLI reference, REST API endpoints
- reference/mcp_server.md: NEW — MCP stdio server, 12 tools with I/O
examples, 3 resources, Claude Desktop/VS Code/Windsurf/Cline config
- docs.json: explorer added to Output group, mcp_server to Utilities group
- Chat, feedback (thumbs/suggest/raise), OG/Twitter metadata, search topbar
- All reference pages reformatted with Mintlify JSX components
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com >
2026-05-22 21:52:50 +05:30
KaifAhmad1
37bc3add62
Update documentation and changelog for Pinecone support
2026-01-26 21:44:44 +05:30
KaifAhmad1
1568237ce7
Add high-performance VectorStore ingestion and docs
2026-01-19 13:32:16 +05:30
KaifAhmad1
04eea7e7eb
Update documentation: reduce code examples, add cookbook links, improve structure
...
- Reduced code examples in all guide pages (getting-started, quickstart, concepts, modules, examples, use-cases, learning-more)
- Added comprehensive cookbook links with descriptions (topics, difficulty, time, use cases)
- Improved structure and organization across all guide pages
- Updated use-cases.md to only include use cases with corresponding cookbooks
- Removed 'Last Updated: 2024' from all documentation files
- Enhanced navigation with better 'Next Steps' sections
2025-12-31 15:19:08 +05:30
KaifAhmad1
dd6b341fb9
Refactor: Rename Adapter to Store across Vector, Graph, and Triplet stores. Update docs and tests.
2025-12-16 20:45:11 +05:30
KaifAhmad1
f3dd7a05bd
Refactor: Remove Pinecone and enhance vector store backend support
...
- Removed all Pinecone references, adapters, and documentation to align with open-source, self-hosted focus.
- Removed PineconeAdapter and related dependencies.
- Updated VectorStore to enforce supported backends (FAISS, Weaviate, Qdrant, Milvus, InMemory).
- Updated cookbooks (e.g., 13_Vector_Store.ipynb) to use Weaviate/FAISS examples instead of Pinecone.
- Updated core documentation (modules.md, rchitecture.md, etc.) to reflect backend changes.
- Added new tests ( est_pinecone_removal.py, est_vector_store_deepdive.py) to verify removal and validate remaining backends.
- Verified all vector store tests pass.
2025-12-12 20:19:17 +05:30
KaifAhmad1
cf56dad82a
docs: update cookbook links to absolute GitHub URLs in reference docs
2025-12-09 16:51:28 +05:30
KaifAhmad1
06145fd4b9
docs(vector_store): finalize documentation with simplified notebooks
...
- Enhanced docs/reference/vector_store.md (~575 lines)
- All 32 classes documented
- All 10 convenience functions
- Complete adapter documentation
- Updated cookbook/introduction/13_Vector_Store.ipynb
- 10-step comprehensive guide
- Created cookbook/advanced/Advanced_Vector_Store_and_Search.ipynb
- 4 focused parts (removed error handling per user request)
- Part 1: Index selection (Flat, HNSW, IVF)
- Part 2: Smart filtering with metadata
- Part 3: Result fusion (RRF, weighted)
- Part 4: Multi-tenant data isolation
- Beginner-friendly with clear examples
- Quick reference guide included
All vector_store documentation complete and production-ready.
2025-12-08 19:55:23 +05:30
KaifAhmad1
a8edbfbfb3
docs: enhance reference documentation for all modules
2025-11-30 19:23:25 +05:30
KaifAhmad1
409f3fdd27
Enhance documentation visual appeal and fix build errors
...
- Added grid‑card layouts, icons, and admonitions to all reference pages
- Removed all mkdocstrings ::: directives that caused alias‑resolution errors
- Fixed export module alias issue (RDFExporter) by cleaning the docs
- Updated README‑style sections for better readability
- Added a PowerShell helper script (remove_mkdocstrings.ps1) for future clean‑ups
2025-11-23 19:23:13 +05:30
KaifAhmad1
b716b17bde
Upgrade documentation: mkdocstrings, jupyter notebooks, and theme fix
2025-11-22 14:49:08 +05:30