Commit Graph
403 Commits
Author SHA1 Message Date
Mohd Kaif 4f6db9601c Merge pull request #685 from Sameer6305/docs/improve-ontology-guide
docs: improve ontology guide onboarding and practical guidance
2026-06-26 12:09:55 +05:30
KaifAhmad1 5f6cac0a77 fix(docs): correct code errors in ontology guide simple example
- Replace ctx.store() + graph.to_dict() with direct entity/relationship
  dict to avoid key mismatch (to_dict() returns nodes/edges; generator
  reads entities/relationships)
- Fix prop type filter: 'datatype' → 'data' (value set by PropertyGenerator)
- Fix domain/range printing: both are stored as lists, not scalars
- Clarify Reasoning bullet: OWL inference requires an external reasoner,
  Semantica only exports the ontology
- Remove duplicate LLM-vs-graph-generator pitfall already covered by the
  Info callout in the LLMOntologyGenerator section
2026-06-26 11:53:56 +05:30
Sameer KadamandKaifAhmad1 e87f0832a3 docs: improve pipeline guide onboarding and workflow guidance (#683)
* docs: improve pipeline guide onboarding and workflows

* fix(docs): correct broken pipeline guide examples from review

- Remove Option 1 (register_step_handler + string name): ExecutionEngine
  never resolves string handler names via step_registry, so it raised
  TypeError at runtime; replace with the single working pattern
- Add missing step_type positional arg to all new add_step() calls
- Use connect_steps() for checkpoint dependency instead of the
  dependencies= kwarg, consistent with every other example in the file
- Move extract_entities definition above its call site to fix NameError
- Replace docstring on save_checkpoint with inline comment to match
  the no-docstring convention used by all other handlers in the file

---------

Co-authored-by: KaifAhmad1 <kaifahmad087@gmail.com>
2026-06-25 12:53:08 +05:30
Mohd Kaif 48c706ef88 Merge pull request #682 from Sameer6305/docs/improve-ingest-guid
docs: improve ingest guide onboarding, workflows, and real-world examples
2026-06-25 12:16:52 +05:30
KaifAhmad1 dd7d1b8bc5 fix(docs): address review findings in ingest guide
- Expand intro to cover Git (dict/code_files) and stream (StreamMessage/.content) return shapes, which the previous two-class split omitted
- Add missing imports and AgentContext setup to the Source 1 internal-docs snippet (NameError on copy-paste)
- Add advanced_analytics=True to ContextGraph in both Business Examples (required for extract_entities=True to populate graph analytics)
- Replace bare `pass` credential with YOUR_DB_PASSWORD placeholder to match the YOUR_*_KEY convention used elsewhere
- Guard nullable description/resolution columns in ticket_texts with `(r[...] or '')` to prevent TypeError on NULL rows
- Replace misleading time.sleep() rate-limit advice with accurate description of RESTIngestor's built-in 429 retry/backoff and how to tune it
2026-06-25 11:59:06 +05:30
Sameer6305 f6e9ef6627 docs: improve change management guide onboarding and workflow guidance 2026-06-24 20:29:52 +05:30
Sameer6305 9bda477847 docs: improve SHACL validation guide onboarding and workflow guidance 2026-06-24 20:10:27 +05:30
Sameer6305 5c512a5011 docs: improve conflict resolution guide onboarding and workflow guidance 2026-06-24 17:30:53 +05:30
Sameer6305 d9b24d0630 docs: improve deduplication guide onboarding and workflow guidance 2026-06-24 16:43:22 +05:30
Sameer6305 527726faa3 docs: improve policy engine onboarding and rule guidance 2026-06-24 16:16:15 +05:30
Sameer6305 7f6f0c4213 docs: improve multi-agent guide onboarding and coordination guidance 2026-06-24 13:23:29 +05:30
Sameer6305 76201b7587 docs: improve export guide onboarding and workflow guidance 2026-06-24 13:01:16 +05:30
KaifAhmad1 b2c949f7de fix(deploy): harden security in deployment templates and explorer app
- GCP: remove --allow-unauthenticated, restrict ingress to
  internal-and-cloud-load-balancing, replace wildcard ALLOWED_ORIGINS=*
  with a substitution variable (_ALLOWED_ORIGINS) so operators supply a
  real URL at deploy time; same fix in cloudrun-service.yaml
- Fly.io: replace hardcoded FALKORDB_HOST=localhost with the correct
  .internal private-network hostname pattern; update README accordingly
- docker-compose.dev.yml: add missing top-level networks: block so the
  frontend service can join the semantica network without --file layering
- K8s/Helm: add readOnlyRootFilesystem: true + runAsUser: 1000 to
  container securityContext; mount an emptyDir /tmp so uvicorn can write
  temp files
- app.py: fix _read_explorer_settings() or-chain, use in os.environ
  checks so an explicit ALLOWED_ORIGINS="" produces an empty allow-list
  instead of silently falling through to localhost defaults; remove dead
  app.state.falkordb_host/port attributes
- docs: update four locations that still documented {"status":"healthy"}
  to reflect the new {"status":"ok"} health response
- tests: update test assertion to read falkordb settings from
  app.state.explorer_settings instead of removed top-level attributes
2026-06-24 12:51:09 +05:30
Sameer6305 25bee71a46 docs: improve semantic extraction guide onboarding and workflow guidance 2026-06-24 12:18:19 +05:30
Sameer6305 9020973498 docs: improve llm integrations guide onboarding and provider guidance 2026-06-23 19:31:46 +05:30
Sameer6305 b84441066d docs: improve decision intelligence guide onboarding and practical guidance 2026-06-23 19:11:20 +05:30
Sameer6305 3126905e2d docs: improve visualization guide onboarding and workflow guidance 2026-06-23 16:35:22 +05:30
Sameer6305 3f009a3ae5 docs: improve graph analytics guide onboarding and practical guidance 2026-06-23 16:21:34 +05:30
Sameer6305 252a7e76b3 docs: improve reasoning guide onboarding and practical guidance 2026-06-23 16:08:56 +05:30
Sameer6305 2d5d615f42 docs: improve context graph guide onboarding and concepts 2026-06-23 15:46:31 +05:30
Sameer6305 b693a9cd9f docs: improve ontology guide onboarding and concepts 2026-06-23 15:16:30 +05:30
Sameer6305 d00a5e53b4 docs: improve ingest guide onboarding and examples 2026-06-23 13:04:21 +05:30
KaifAhmad1 5e7c929ca8 docs: lighten code block hover — subtle lift + faint ring 2026-06-22 16:43:27 +05:30
KaifAhmad1 350b0a953f docs: upgrade custom.css to premium design system
Replace uniform cursor-bar hover effects with a differentiated,
light animation layer per element type. Adds global polish:
smooth scroll, custom scrollbar, brand-colored text selection,
page fade-in entrance, emerald focus rings, H1 gradient underline
accent, styled blockquotes, gradient HR dividers, uppercase table
headers, and CTA button glow — all tuned to the #080C10 dark
background and #10B981 emerald brand color.
2026-06-22 16:27:16 +05:30
Mohd KaifandSameer6305 5db740100e Align guides with current source APIs (#676)
* align guides with current source APIs

* docs(guides): align context graph and visualization examples with source APIs

* docs(guides): fix reasoning and approval chain examples

* docs(graphrag): fix multiline string examples

* docs(pipeline): align handler examples with execution engine

* docs(ontology): align graph serialization example with ContextGraph API

* docs(llm): fix Triplet example attribute access

---------

Co-authored-by: Sameer6305 <sskadam6305@gmail.com>
2026-06-22 15:58:17 +05:30
Sameer Kadam f35a976a03 docs: align onboarding examples with current APIs (#664) 2026-06-20 22:18:16 +05:30
Sameer Kadam 011a21d0b3 docs: fix broken links and stale notebook references (#660) 2026-06-20 19:27:30 +05:30
KaifAhmad1 e1b7b072b8 docs: replace Changelog tab with GitHub Releases external link; update inline links 2026-06-20 17:01:00 +05:30
KaifAhmad1 a9a72977a9 docs: fix trailing comma in docs.json after tab removal 2026-06-20 16:53:44 +05:30
KaifAhmad1 c5c27b35aa docs: remove Changelog tab from nav — diagnose export failure (step 2) 2026-06-20 16:49:57 +05:30
KaifAhmad1 eddb7dd914 docs: strip changelog to minimal stub — diagnose export failure 2026-06-20 16:45:28 +05:30
KaifAhmad1 59aa3f1d86 docs: add mintlify export + JSX balance checks to docs_check.py; run on PRs 2026-06-20 16:28:02 +05:30
KaifAhmad1 ce8344aa73 docs: rewrite changelog as flat markdown — remove heavy accordion nesting 2026-06-20 16:11:48 +05:30
KaifAhmad1 5515390269 docs: add unreleased note and tighten changelog defaultOpen syntax 2026-06-20 15:53:59 +05:30
Mohd Kaif 1bd2ecfef2 docs: add Changelog tab and clean up overview page (#658)
* docs: add Changelog tab and clean up overview page

- Remove v0.5.0 release banner and stats grid from docs/index.md
- Add Changelog navigation tab to docs/docs.json after FAQ
- Create docs/changelog.md sourced from CHANGELOG.md with full Mintlify
  formatting: one accordion per release (Unreleased → v0.0.1), icons,
  pip install snippets, Added/Fixed/Security sub-sections, and a change
  type legend

* docs: fix broken index#whats-new link in quickstart — point to changelog
2026-06-20 15:43:41 +05:30
Sameer KadamandKaifAhmad1 b882579e2d docs: fix onboarding examples for GraphBuilder and temporal queries (#656)
* docs: fix onboarding examples for GraphBuilder and temporal queries

* docs: fix provenance import, hollow example, and query comment (#656 follow-up)

- Fix wrong import: ProvenanceTracker lives in semantica.kg, not semantica.provenance
- Replace hollow provenance accordion with actual track_entity/get_all_sources example
- Annotate query="" in TemporalGraphQuery.query_at_time as reserved for future use

* docs: use ProvenanceManager from semantica.provenance in W3C PROV-O example

---------

Co-authored-by: KaifAhmad1 <kaifahmad087@gmail.com>
2026-06-20 13:47:20 +05:30
Sameer Kadam 6b14253157 docs: align Explorer module references with actual CLI usage (#655) 2026-06-19 16:24:06 +05:30
Sameer KadamandKaifAhmad1 926d4c1653 docs: add choose-your-module onboarding guide (#651)
* docs: add choose-your-module onboarding guide

* fix(docs): correct export code examples against actual API signatures

- export_to_rdf() returns a string; use export() for file output
- format="json-ld" is invalid; correct value is "jsonld"
- ParquetExporter/LPGExporter/ArangoAQLExporter take file_path as a
  required positional arg, not output= / output_dir= kwargs
- ArangoAQLExporter().export(graph) was missing file_path entirely,
  which would raise TypeError at runtime
- Remove misleading 'with provenance embedded' comment (no such param)

---------

Co-authored-by: KaifAhmad1 <kaifahmad087@gmail.com>
2026-06-19 13:15:06 +05:30
Mohd Kaif 12d61b92df docs: add Temporal & Distance Intelligence reference pages with accurate API (#650)
- Add docs/reference/temporal.md: full Temporal Intelligence reference covering
  bi-temporal model (TemporalBound.OPEN sentinel, BiTemporalFact.from_relationship()
  factory), TemporalGraphQuery (query_at_time, reconstruct_at_time, query_time_range,
  find_temporal_paths, analyze_evolution, validate_temporal_consistency),
  TemporalPatternDetector, TemporalReasoningEngine with all 13 Allen interval
  relations over TemporalInterval objects, TemporalNormalizer (returns
  Optional[Tuple[datetime, datetime]]), TemporalQueryRewriter.rewrite() returning
  TemporalQueryResult, and TemporalVersionManager with SQLite storage and correct
  method names (list_versions, compare_versions, get_version, apply_revision,
  validate_snapshot, verify_checksum)

- Add docs/reference/distance.md: Distance Intelligence reference with corrected
  SimilarityCalculator API (pairwise_similarity, batch_similarity, find_most_similar)
  and semantic neighborhood / proximity-blended retrieval patterns

- Update docs/reference/kg.md: expand Exported Classes table to include all
  TemporalPatternDetector, TemporalInterval, IntervalRelation, TemporalQueryResult,
  AlgorithmTrackerWithProvenance, AlgorithmRegistry, ProvenanceTracker, SeedManager,
  KGConfig; fix all temporal code examples to use correct constructors and method names

- Update docs/reference/context.md: add Distance Intelligence section

- Update docs/index.md: add v0.3.0 release accordion with feature highlights

- Update docs/docs.json: wire temporal and distance pages into Modules navigation
2026-06-18 13:37:24 +05:30
Zohaib Hassnain 0765cfea77 docs: add CLI demo gif (#649) 2026-06-18 01:52:24 +05:30
Mohd Kaif 25289023fe docs: replace all CardGroup/Card blocks with animated bullet points across all 50 docs pages (#648)
- Fix What's new → link in Info banner (now a proper <a> tag, always clickable)
- Replace 4-stat CardGroup on index with inline premium stats row
- Convert every <CardGroup>/<Card> block site-wide to markdown bullet lists:
  content sections → bold-title bullets with sub-bullets, nav cards → [Title](href) — description
- Add cursor-animated list item hover effects to custom.css:
  green inset left border, subtle background tint, marker color change on hover
- Affects index, getting-started, quickstart, concepts, modules, faq, architecture,
  installation, cookbook, glossary, learning-more, explorer-setup, cli-setup,
  community, contributing-guide, governance, citation, project-license,
  all integrations pages, and all 20+ reference module pages
2026-06-17 23:18:40 +05:30
Mohd Kaif 0f9a651527 remove: delete domain-specific use_cases cookbooks and docs (#647)
Removes all notebooks, data files, and exports under cookbook/use_cases/
(advanced_rag, biomedical, blockchain, capability_gap_defense, cybersecurity,
finance, intelligence, renewable_energy, supply_chain) and the corresponding
docs/use-cases.md page.

Cleans up all references in docs/cookbook.md, docs/docs.json,
docs/concepts.md, docs/modules.md, and docs/learning-more.md.
2026-06-17 22:13:50 +05:30
Mohd Kaif e04dc12e6e docs: premium UI improvements — navbar links, hover effects, inline tips, accordion troubleshooting (#646)
- Move Discord, GitHub, PyPI, and Follow on X links from sidebar anchors to top-right navbar
- Lock dark mode as default via appearance.strict and hide theme toggle
- Add custom.css with hover highlighting for tables, code blocks, cards, callouts, and inline code
- Move all Tips and Common Pitfalls sections inline next to their relevant content across all 25 reference docs
- Polish context.md: remove duplicates, condense callouts, upgrade Cookbooks to CardGroup
- Convert Troubleshooting and Performance Optimization sections in installation.md, cli-setup.md, explorer-setup.md, learning-more.md, and faq.md from plain headers to AccordionGroup
- Change navigation-hint Tip callouts to Info in concepts.md, faq.md, glossary.md, and modules.md
2026-06-17 18:59:25 +05:30
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 8f2910fc33 fix: replace invalid Mintlify theme 'venus' with 'mint' (#644) 2026-06-17 13:11:07 +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
KaifAhmad1 850f47625f docs: address review feedback across 7 modules
- llms.md: use showcase models (llama-3.3-70b-versatile, gpt-4o) in
  provider examples and use-case tables; clarify defaults vs recommended
  in Defaults and Reproducibility section
- split.md: document that chunk_size is in characters with migration note
- ingest.md: add Note that glob patterns are not supported by ingest()
- explorer-setup.md: remove hardcoded "1.5 seconds" timing claim
- cli-setup.md: expand semantica-worker description with concrete usage
- mcp_server.md: clarify turtle/ttl are aliases for the same RDF format
- semantic_extract.md: remove emoji from code comments
2026-06-16 21:49:20 +05:30
Sameer6305 f608b1f75f docs: add CLI and Explorer setup guides 2026-06-16 19:22:42 +05:30
Sameer6305 fc22805e44 docs(change_management): align versioning APIs with implementation 2026-06-16 15:17:38 +05:30
Sameer6305 f2bf1e2159 docs(conflicts): align conflict APIs with implementation 2026-06-16 15:03:28 +05:30