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).
This commit is contained in:
Mohd Kaif
2026-06-17 12:58:44 +05:30
committed by GitHub
parent 0e95de4622
commit 1f3cea5f0a
53 changed files with 2660 additions and 1216 deletions
+13 -4
View File
@@ -4,10 +4,11 @@ description: "Install the Explorer extras, save a ContextGraph to JSON, and laun
icon: "map"
---
`semantica-explorer` is an interactive browser dashboard for knowledge graph exploration. You give it a graph file, it starts a local server, and opens a browser tab where you can search nodes, find paths, inspect provenance, and run analytics — no code required after launch.
**`semantica-explorer`** is an **interactive browser dashboard** for knowledge graph exploration. You give it a graph file, it starts a local server, and opens a browser tab where you can search nodes, find paths, inspect provenance, and run analytics — no code required after launch.
This page covers everything needed to go from zero to a running Explorer. For the full REST API reference and endpoint catalogue, see [Explorer Reference](reference/explorer).
## Prerequisites
The Explorer depends on FastAPI and uvicorn, which are not included in the base install:
@@ -28,6 +29,7 @@ semantica-explorer --help
You should see the usage message with the four available flags. If you see `command not found`, activate your virtual environment first. See [CLI Setup](cli-setup#troubleshooting) for PATH help.
## Minimal End-to-End Example
The following four steps are everything needed to get Explorer running:
@@ -57,6 +59,7 @@ curl http://127.0.0.1:8000/api/health
# {"status": "healthy"}
```
## Step 1 — Build and Save a ContextGraph
Explorer loads a graph from a JSON file on disk. You need to create that file first.
@@ -109,6 +112,7 @@ Explorer loads a graph from a JSON file on disk. You need to create that file fi
Already have a graph from a pipeline run? Skip straight to Step 2. The only requirement is that the file was saved with `ContextGraph.save_to_file()`.
</Tip>
## Step 2 — Launch Explorer
```bash
@@ -127,13 +131,14 @@ The startup sequence prints:
The browser opens automatically at `http://127.0.0.1:8000` shortly after the server starts.
## CLI Flags
`semantica-explorer` accepts exactly four flags:
| Flag | Short | Default | Description |
| ---- | ----- | ------- | ----------- |
| `--graph` | `-g` | *(required)* | Path to a ContextGraph JSON file |
| :---- | :----- | :------- | :----------- |
| `--graph` | `-g` | *(**required**)* | Path to a ContextGraph JSON file |
| `--port` | `-p` | `8000` | Port to bind the server |
| `--host` | — | `127.0.0.1` | Host to bind the server |
| `--no-browser` | — | off | Do not open a browser tab automatically |
@@ -160,18 +165,20 @@ semantica-explorer --graph my_graph.json --no-browser
`--host 0.0.0.0` makes Explorer reachable on every network interface. The server has no built-in authentication. Only use this on a trusted private network.
</Warning>
## Browser Access
Once the server is running:
| URL | What you get |
| --- | ------------ |
| :--- | :------------ |
| `http://127.0.0.1:8000` | Interactive dashboard |
| `http://127.0.0.1:8000/docs` | Swagger UI — every REST endpoint, interactive |
| `http://127.0.0.1:8000/api/health` | Health check — `{"status": "healthy"}` |
The browser tab opens shortly after startup. If it does not open, navigate to the URL manually or pass `--no-browser` and open it yourself.
## Running as a Python Module
If `semantica-explorer` is not on `PATH`, use the module form:
@@ -180,6 +187,7 @@ If `semantica-explorer` is not on `PATH`, use the module form:
python -m semantica.explorer --graph my_graph.json --port 8080
```
## Common Startup Errors
**`Error: graph file not found: my_graph.json`**
@@ -228,6 +236,7 @@ semantica-explorer --graph my_graph.json --host 0.0.0.0
This is expected in headless, SSH, and container environments. Add `--no-browser` to suppress the warning and open `http://127.0.0.1:8000` in a browser that has network access to the server.
## What Explorer Gives You
Once running, Explorer exposes a REST API and dashboard for: