Skip to content

Commit f1814fd

Browse files
committed
Added a Zensical documentation website with existing/new markdown files, ui guide covers the 13 data source forms
1. Zensical docs site: zensical.toml, GitHub Actions workflow (docs.yml) 2. Documentation web site will have Getting Started, Configuration, UI Guide, Data Sources, LLM, Databases, MCP, Developer, and Advanced sections 3. docs/ restructured into section folders (HOME, GETTING-STARTED, CONFIGURATION, UI-GUIDE, DATABASES, DEVELOPER, ADVANCED) 4. New UI Guide pages covering all 4 tabs and 13 data source forms 5. React, Angular, Vue screenshots — 4 tabs dark/light themes each; 13 React data source form screenshots 6. Full nav tree configured in zensical.toml for all 9 sections 7. All cross-reference links updated in docs files and README.md 8. Angular UI: standard Angular favicon; renamed cmis-graphrag-ui to flexible-graphrag-ui in package.json and angular.json
1 parent c90651f commit f1814fd

126 files changed

Lines changed: 4882 additions & 1315 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "docs/**"
9+
- "zensical.toml"
10+
- ".github/workflows/docs.yml"
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: false
21+
22+
jobs:
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
29+
- name: Set up Python
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: "3.13"
33+
34+
- name: Install Zensical
35+
run: pip install zensical
36+
37+
- name: Build documentation site
38+
run: zensical build --config-file zensical.toml
39+
40+
- name: Upload Pages artifact
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: site
44+
45+
deploy:
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
runs-on: ubuntu-latest
50+
needs: build
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Zensical / MkDocs built output
2+
site/
3+
14
# Environment variables
25
.env
36
.env.local

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [2026-04-16] - With existing / new md content will how have a Zensical documentation website, including a user guide with coverage of the 13 data source forms and 4 tabs
6+
7+
### Added
8+
- **Zensical documentation site** — new `zensical.toml` config and `docs/` folder structure powering a full documentation site hosted on GitHub Pages at `https://stevereiner.github.io/flexible-graphrag/`; GitHub Actions workflow (`.github/workflows/docs.yml`) auto-deploys on push to `main`; new `HOME/`, `GETTING-STARTED/`, `CONFIGURATION/`, `UI-GUIDE/`, `DEVELOPER/`, `ADVANCED/` section folders with new index/hub pages for each section
9+
- **Documentation website sections and navigation** — full `nav` tree configured in `zensical.toml` covering Getting Started, Configuration, UI Guide, Data Sources, LLM, Databases, MCP, Developer, and Advanced; combines existing and new Markdown content into a navigable site covering the full product
10+
- **UI Guide with data source coverage** — new `UI-TAB-SOURCES.md` covers all 13 data source configuration forms; `UI-TAB-PROCESSING.md`, `UI-TAB-SEARCH.md`, `UI-TAB-CHAT.md` cover all 4 UI tabs; `UI-SCREENSHOTS.md` provides overview screenshots
11+
- **New UI screenshots** — React, Angular, and Vue frontend screenshots for all 4 tabs in dark and light themes (8 screenshots per frontend); 13 React data source form screenshots covering all supported sources
12+
- **New documentation pages**`DEVELOPER-DOCS-SYSTEM.md` (local preview, build, deploy instructions) and HOME hub pages for all nav sections
13+
14+
### Changed
15+
- **Documentation restructured into section folders** — existing `docs/` root files reorganized into section folders; `INCREMENTAL-UPDATE-AUTO-SYNC/` and `DOC-PROCESSING/` moved under `DATA-SOURCES/`; `GRAPH-DATABASES/`, `VECTOR-DATABASES/`, `RDF/` moved under `DATABASES/`; `OBSERVABILITY/` moved under `DEVELOPER/`; `LANGCHAIN/` moved under `ADVANCED/`; all cross-reference links updated in `zensical.toml`, docs files, and root `README.md`
16+
- **UI Screenshots page** — React section first (before Angular and Vue); dark and light theme tabs for all three frontends
17+
- **Angular UI** — replaced Alfresco favicon with standard Angular favicon; renamed leftover `cmis-graphrag-ui` project name to `flexible-graphrag-ui` in `package.json`, `angular.json` (project key, output path, and all `buildTarget` references)
18+
519
## [2026-04-12] - Ladybug Package Rename, Version 0.5.2
620

721
### Fixed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -205,14 +205,14 @@ POSTGRES_INCREMENTAL_URL=postgresql://postgres:password@localhost:5433/postgres
205205

206206
**PostgreSQL for State Management**:
207207

208-
The `docker/includes/postgres-pgvector.yaml` sets up two databases automatically on first start: `flexible_graphrag` (for optional pgvector vector storage) and `flexible_graphrag_incremental` (for incremental update state management, with its schema created automatically). pgAdmin is also configured at http://localhost:5050 with both databases pre-registered — just enter the master password `admin` when prompted, then use `password` for the server connection and save it. See [docs/POSTGRES-SETUP.md](docs/POSTGRES-SETUP.md) for details.
208+
The `docker/includes/postgres-pgvector.yaml` sets up two databases automatically on first start: `flexible_graphrag` (for optional pgvector vector storage) and `flexible_graphrag_incremental` (for incremental update state management, with its schema created automatically). pgAdmin is also configured at http://localhost:5050 with both databases pre-registered — just enter the master password `admin` when prompted, then use `password` for the server connection and save it. See [docs/DATABASES/POSTGRES-SETUP.md](docs/DATABASES/POSTGRES-SETUP.md) for details.
209209

210210
**Documentation**:
211-
- System overview: [`docs/INCREMENTAL-UPDATE-AUTO-SYNC/README.md`](docs/INCREMENTAL-UPDATE-AUTO-SYNC/README.md)
212-
- Quick start: [`docs/INCREMENTAL-UPDATE-AUTO-SYNC/QUICKSTART.md`](docs/INCREMENTAL-UPDATE-AUTO-SYNC/QUICKSTART.md)
213-
- Detailed setup: [`docs/INCREMENTAL-UPDATE-AUTO-SYNC/SETUP-GUIDE.md`](docs/INCREMENTAL-UPDATE-AUTO-SYNC/SETUP-GUIDE.md)
214-
- API reference: [`docs/INCREMENTAL-UPDATE-AUTO-SYNC/API-REFERENCE.md`](docs/INCREMENTAL-UPDATE-AUTO-SYNC/API-REFERENCE.md)
215-
- PostgreSQL setup: [`docs/POSTGRES-SETUP.md`](docs/POSTGRES-SETUP.md)
211+
- System overview: [`docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/README.md`](docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/README.md)
212+
- Quick start: [`docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/QUICKSTART.md`](docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/QUICKSTART.md)
213+
- Detailed setup: [`docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/SETUP-GUIDE.md`](docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/SETUP-GUIDE.md)
214+
- API reference: [`docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/API-REFERENCE.md`](docs/DATA-SOURCES/INCREMENTAL-UPDATE-AUTO-SYNC/API-REFERENCE.md)
215+
- PostgreSQL setup: [`docs/DATABASES/POSTGRES-SETUP.md`](docs/DATABASES/POSTGRES-SETUP.md)
216216

217217
**Scripts**:
218218
- `scripts/incremental/sync-now.sh|.ps1|.bat` - Trigger immediate synchronization
@@ -234,7 +234,7 @@ All data sources support two document parser options:
234234
- **New**: `DOCLING_DEVICE=auto|cpu|cuda|mps` - Control GPU vs CPU processing
235235
- **New**: `SAVE_PARSING_OUTPUT=true` - Save intermediate parsing results for inspection (works for both parsers)
236236
- **New**: `PARSER_FORMAT_FOR_EXTRACTION=auto|markdown|plaintext` - Control format used for knowledge graph extraction
237-
- See [Docling GPU Configuration Guide](docs/DOC-PROCESSING/DOCLING-GPU-CONFIGURATION.md) for setup details | [Quick Reference](DOCLING-QUICK-REFERENCE.md)
237+
- See [Docling GPU Configuration Guide](docs/DATA-SOURCES/DOC-PROCESSING/DOCLING-GPU-CONFIGURATION.md) for setup details | [Quick Reference](docs/DATA-SOURCES/DOC-PROCESSING/DOCLING-GPU-CONFIGURATION.md#quick-reference-installation-commands)
238238

239239
**LlamaParse**:
240240
- Cloud-based API service with advanced AI
@@ -337,7 +337,7 @@ Flexible GraphRAG uses three types of databases for its hybrid search capabiliti
337337
- **Ollama**: 384 dimensions (all-minilm, default), 768 dimensions (nomic-embed-text), or 1024 dimensions (mxbai-embed-large)
338338
- **Azure OpenAI**: Same as OpenAI (1536 or 3072 dimensions)
339339

340-
**See [docs/VECTOR-DATABASES/VECTOR-DIMENSIONS.md](docs/VECTOR-DATABASES/VECTOR-DIMENSIONS.md) for detailed cleanup instructions for each database.**
340+
**See [docs/DATABASES/VECTOR-DATABASES/VECTOR-DIMENSIONS.md](docs/DATABASES/VECTOR-DATABASES/VECTOR-DIMENSIONS.md) for detailed cleanup instructions for each database.**
341341

342342
#### Supported Vector Databases
343343

@@ -562,9 +562,9 @@ includes:
562562
# - includes/oxigraph.yaml
563563
```
564564

565-
**Complete Documentation:** [docs/RDF/RDF-ONTOLOGY-SUPPORT.md](docs/RDF/RDF-ONTOLOGY-SUPPORT.md) | [docs/RDF/RDF-STORE-USER-GUIDE.md](docs/RDF/RDF-STORE-USER-GUIDE.md)
565+
**Complete Documentation:** [docs/DATABASES/RDF/RDF-ONTOLOGY-SUPPORT.md](docs/DATABASES/RDF/RDF-ONTOLOGY-SUPPORT.md) | [docs/DATABASES/RDF/RDF-STORE-USER-GUIDE.md](docs/DATABASES/RDF/RDF-STORE-USER-GUIDE.md)
566566

567-
**LangChain RDF retrieval** (`USE_LANGCHAIN_RDF=true`) fuses SPARQL-based results from the configured RDF store directly into hybrid search and AI query alongside vector and graph results. Supports `SynonymExpander` for query keyword expansion, `GraphEntityVectorRetriever` for Neo4j entity vector search, and `GraphNeighborhoodRetriever` for k-hop graph expansion. See [docs/RDF/RDF-STORE-USER-GUIDE.md](docs/RDF/RDF-STORE-USER-GUIDE.md#langchain-rdf-retrieval).
567+
**LangChain RDF retrieval** (`USE_LANGCHAIN_RDF=true`) fuses SPARQL-based results from the configured RDF store directly into hybrid search and AI query alongside vector and graph results. Supports `SynonymExpander` for query keyword expansion, `GraphEntityVectorRetriever` for Neo4j entity vector search, and `GraphNeighborhoodRetriever` for k-hop graph expansion. See [docs/DATABASES/RDF/RDF-STORE-USER-GUIDE.md](docs/DATABASES/RDF/RDF-STORE-USER-GUIDE.md#langchain-rdf-retrieval).
568568

569569
## LLM Configuration
570570

@@ -633,7 +633,7 @@ EMBEDDING_DIMENSION=384 # Auto-detected if not specified
633633
- Ollama: 384 (all-minilm, default), 768 (nomic-embed-text), 1024 (mxbai-embed-large)
634634
- Google: 768 (text-embedding-004, configurable with output_dimensionality parameter)
635635

636-
**Note**: When switching embedding models, you must delete existing vector indexes due to dimension incompatibility. See [docs/VECTOR-DATABASES/VECTOR-DIMENSIONS.md](docs/VECTOR-DATABASES/VECTOR-DIMENSIONS.md) for cleanup instructions.
636+
**Note**: When switching embedding models, you must delete existing vector indexes due to dimension incompatibility. See [docs/DATABASES/VECTOR-DATABASES/VECTOR-DIMENSIONS.md](docs/DATABASES/VECTOR-DATABASES/VECTOR-DIMENSIONS.md) for cleanup instructions.
637637

638638
### Ollama Configuration
639639

@@ -919,7 +919,7 @@ flexible-graphrag
919919
copy env-sample.txt .env # Windows
920920
```
921921

922-
Edit `.env` with your specific configuration. See [docs/ENVIRONMENT-CONFIGURATION.md](docs/ENVIRONMENT-CONFIGURATION.md) for detailed setup guide.
922+
Edit `.env` with your specific configuration. See [docs/GETTING-STARTED/ENVIRONMENT-CONFIGURATION.md](docs/GETTING-STARTED/ENVIRONMENT-CONFIGURATION.md) for detailed setup guide.
923923

924924
**Note**: The system requires Python 3.12, 3.13, or 3.14 as specified in `pyproject.toml` (requires-python = ">=3.12,<3.15"). Python 3.12 and 3.13 are fully tested. Python 3.14 works with the patches applied automatically in `main.py` at startup. Virtual environment management is controlled by `managed = false` in `pyproject.toml` `[tool.uv]` section (you control venv creation and naming).
925925

@@ -1086,8 +1086,8 @@ Interactive conversational interface for document Q&A:
10861086

10871087
Between tests you can clean up data:
10881088
- **Run `cleanup.py`**: Clears vector, graph, and search indexes in one step — run from the `flexible-graphrag` directory
1089-
- **Vector Indexes**: See [docs/VECTOR-DATABASES/VECTOR-DIMENSIONS.md](docs/VECTOR-DATABASES/VECTOR-DIMENSIONS.md) for vector database cleanup instructions
1090-
- **Graph Data**: See [docs/GRAPH-DATABASES/README-neo4j.md](docs/GRAPH-DATABASES/README-neo4j.md) for graph-related cleanup commands
1089+
- **Vector Indexes**: See [docs/DATABASES/VECTOR-DATABASES/VECTOR-DIMENSIONS.md](docs/DATABASES/VECTOR-DATABASES/VECTOR-DIMENSIONS.md) for vector database cleanup instructions
1090+
- **Graph Data**: See [docs/DATABASES/GRAPH-DATABASES/README-neo4j.md](docs/DATABASES/GRAPH-DATABASES/README-neo4j.md) for graph-related cleanup commands
10911091

10921092
## MCP Server Setup (Quickstart)
10931093

@@ -1166,7 +1166,7 @@ The FastAPI backend provides the following REST API endpoints:
11661166
- **Swagger UI**: http://localhost:8000/docs
11671167
- **ReDoc**: http://localhost:8000/redoc
11681168
1169-
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed API workflow and examples.
1169+
See [docs/ADVANCED/ARCHITECTURE.md](docs/ADVANCED/ARCHITECTURE.md) for detailed API workflow and examples.
11701170
11711171
## Full-Stack Debugging (Standalone Mode)
11721172
@@ -1230,7 +1230,7 @@ Flexible GraphRAG includes comprehensive observability features for production m
12301230
</a>
12311231
</p>
12321232
1233-
See [docs/OBSERVABILITY/OBSERVABILITY.md](docs/OBSERVABILITY/OBSERVABILITY.md) for complete setup, custom instrumentation, and production best practices.
1233+
See [docs/DEVELOPER/OBSERVABILITY/OBSERVABILITY.md](docs/DEVELOPER/OBSERVABILITY/OBSERVABILITY.md) for complete setup, custom instrumentation, and production best practices.
12341234
12351235
## Project Structure
12361236

0 commit comments

Comments
 (0)