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
ce765b6f66
fix: correct docs-to-code mismatches in 8 reference modules
...
- graph_store: remove create_constraint(), add_nodes_bulk(), add_edges_bulk() → create_nodes(), add_edges()
- deduplication: fix PropertyMergeRule → MergeStrategy enum; add_rule() → add_property_rule(); merge() → merge_entities(); remove non-existent UNION/MAX/MIN/VOTING constants
- conflicts: set_credibility() → set_source_credibility(); group_by_severity/identify_patterns/analyze_sources → analyze_conflicts() dict keys; generate() → generate_guide(); remove time_window= param from analyze_trends()
- reasoning: infer() → forward_chain(); remove apply_transitivity/symmetry/inverse() templates that don't exist; GraphReasoner(kg) → GraphReasoner(); infer(kg) → reason(graph, query)
- split: split_document() (singular) → split_documents([parsed]) throughout
- seed: remove register_source_object(), populate(), inject(), load_from_file(), diff_versions(), get_version(tag=) — replace with register_source() and load_from_csv/json()
- change_management: remove rollback(), get_log_entry(), export_audit_trail(), get_audit_trail() — replace audit section with list_versions() + diff() pattern
- export: export_to_file() → export_to_rdf(); YAMLExporter → SemanticNetworkYAMLExporter
2026-05-24 13:36:14 +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
3b637ea140
docs(reference): fix class names and expand API coverage across 8 modules
...
- normalize: replace non-existent DataNormalizer with correct classes (TextNormalizer, EntityNormalizer, DateNormalizer, NumberNormalizer, DataCleaner)
- deduplication: replace non-existent EntityResolver with correct API (DuplicateDetector, EntityMerger, SimilarityCalculator, ClusterBuilder)
- reasoning: replace non-existent ReasoningEngine/DeductiveEngine/AbductiveEngine with correct classes (Reasoner, GraphReasoner, ReteEngine, SPARQLReasoner, DatalogReasoner, TemporalReasoningEngine, ExplanationGenerator)
- export: fix ArangoExporter->ArangoAQLExporter, GraphMLExporter->GraphExporter; add ArrowExporter, DistanceExporter, ReportGenerator
- conflicts: fix ResolutionStrategy enum values and add SourceTracker, ConflictAnalyzer, InvestigationGuideGenerator
- change_management: add OntologyVersionManager, VersionStorage backends, compute_checksum/verify_checksum
- embeddings: add TextEmbedder, GraphEmbeddingManager, VectorEmbeddingManager, all provider stores, all pooling strategies
- visualization: fix broken See Also href from evals to explorer
2026-05-22 22:03:30 +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
Mohd Kaif and Claude Sonnet 4.6
b282487b17
docs: rewrite and polish documentation site ( #413 )
...
- Rewrote index.md to match README (tagline, badges, Problem/Solution text)
- Improved getting-started, concepts, quickstart, installation, faq, use-cases, contributing, glossary, learning-more, examples, modules, architecture, cookbook, deep-dive pages: tighter prose, fixed headings/bullets, removed inconsistencies and duplicate sections
- Removed overuse of emojis from headings in integration pages (docling, snowflake)
- Fixed change_management reference page: closed unclosed JSON code block that broke the right TOC, demoted noisy sub-headings to bold text
- CSS layout: widened content area (max-width 1440px grid, left sidebar 11rem, right TOC narrowed to 11rem for broader content), tightened TOC spacing and font size, fixed word-wrap/overflow on TOC links
- Added mkdocs_local.yml for local serving without mkdocs-jupyter plugin
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com >
2026-03-26 18:38:21 +05:30
KaifAhmad1 and ZohaibHassan16
665771f230
fix: address all review feedback on ontology diff implementation
...
- Fix typo in ChangeCategory enum: "potenitally_breaking" → "potentially_breaking"
- Fix missing space in _classify_change description string: "New{type}" → "New {type}"
- Add null-value guard in _analyze_field_changes for unset constraint fields
- Make ChangeLogAnalyzer stateless: pass report as arg to _generate_recommendations
- Remove no-op __init__ from ChangeLogAnalyzer
- Replace non-portable emoji markers in recommendations with plain-text tags
- Extend diff_ontologies to cover individuals and axioms (not just classes/properties)
- Fix exception chaining in compare_versions: raise ... from e
- Remove silent ImportError swallow for GraphValidator (it is a first-party module)
- Add comment on deferred VersionManager import explaining circular-import reason
- Fix import-before-docstring in test_managers.py
- Add tests: version-not-found error path, individuals/axioms diff coverage,
null constraint flagged as breaking
- Fix broken Markdown link syntax in docs JSON example block
- Update docs recommendations example to match new plain-text tag format
Co-authored-by: ZohaibHassan16 <zohaib179949@gmail.com >
Co-authored-by: KaifAhmad1 <kaifahmad087@gmail.com >
2026-03-16 22:05:12 +05:30
ZohaibHassan16
9a2b2b9cd1
fix: resolve code review feedback for diff engine and report format
2026-03-10 00:37:48 +05:00
ZohaibHassan16
c842af65d0
feat: implement ontology dif
2026-03-10 00:01:36 +05:00
ZohaibHassan16
59ff25fc06
feat: implement incremental delta processing
2026-02-25 02:55:12 +05:00
KaifAhmad1
ad06957f93
Fix card icons and remove unused files
...
- Replace problematic Material Design Icons with verified working icons
- Fix icon rendering issues in provenance.md and change_management.md
- Replace :material-route: with :material-link-variant: for Complete Lineage
- Replace :material-account-tree: with :material-graph: for Knowledge Graph Versioning
- Replace :material-schema: with :material-shape: for Ontology Versioning
- Replace :material-audit: with :material-clipboard-check: for Audit Trail Compliance
- Replace :material-bridge: with :material-share-variant: for Bridge Axiom Support
- Remove PR_DESCRIPTION.md and SNOWFLAKE_IMPLEMENTATION.md unused files
- All cards now display consistently with proper icons
2026-02-05 22:06:46 +05:30
KaifAhmad1
d3b579208c
Comprehensive documentation cleanup and improvements
...
## Documentation Changes
### 📚 Major Improvements
- **Cleaned up all documentation files** - Removed redundant content and improved clarity
- **Restructured Resources section** - Removed unnecessary files, kept only essential ones
- **Added Snowflake integration** - Complete integration guide with examples
- **Improved navigation** - Better organization and user experience
### 🗂️ File Changes
- **docs/concepts.md** - Rewritten to be clean and user-friendly
- **docs/modules.md** - Updated with current modules and removed emojis
- **docs/glossary.md** - Reorganized thematically instead of alphabetically
- **docs/getting-started.md** - Made more concise and practical
- **docs/community.md** - Clean, focused community guide
- **docs/contributing.md** - Clear contribution guidelines
- **docs/faq.md** - Comprehensive FAQ with practical answers
- **docs/license.md** - Clean license explanation
- **docs/css/custom.css** - Fixed CSS syntax and organization
### 🔧 Technical Changes
- **mkdocs.yml** - Updated navigation, removed redundant files
- **docs/integrations/snowflake.md** - New comprehensive Snowflake guide
- **docs/reference/ingest.md** - Added Snowflake references
- **Removed files**: changelog.md, release-guide.md, change_management_usage.md, community-projects.md, architecture.md, governance.md, citation.md
### 🎯 Benefits
- **Better user experience** - Clean, easy to navigate documentation
- **Reduced redundancy** - No duplicate or unnecessary content
- **Professional quality** - Enterprise-ready documentation
- **Consistent style** - Uniform formatting across all files
This commit includes all documentation improvements while maintaining the main branch's stability.
2026-02-05 17:43:16 +05:30
KaifAhmad1
b3f3ac413c
Add Enhanced Change Management Module with comprehensive testing and documentation
...
- New semantica.change_management module with persistent version storage
- Core classes: TemporalVersionManager, OntologyVersionManager, ChangeLogEntry
- Storage backends: SQLite (persistent) and InMemory (fast)
- Features: SHA-256 checksums, detailed entity/relationship diffs, email validation
- Compliance: HIPAA, SOX, FDA 21 CFR Part 11 support with audit trails
- Testing: 104 tests (100% pass) - unit, integration, compliance, performance
- Performance: 17.6ms for 10k entities, 510+ ops/sec concurrent
- Documentation: Complete usage guide and API reference
- Backward compatible with simplified class names
2026-01-30 15:51:07 +05:30
Mohd Kaif