You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: CHANGELOG.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,20 @@
2
2
3
3
All notable changes to this project will be documented in this file.
4
4
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
+
5
19
## [2026-04-12] - Ladybug Package Rename, Version 0.5.2
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.
209
209
210
210
**Documentation**:
211
-
- System overview: [`docs/INCREMENTAL-UPDATE-AUTO-SYNC/README.md`](docs/INCREMENTAL-UPDATE-AUTO-SYNC/README.md)
- **Azure OpenAI**: Same as OpenAI (1536 or 3072 dimensions)
339
339
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.**
**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).
568
568
569
569
## LLM Configuration
570
570
@@ -633,7 +633,7 @@ EMBEDDING_DIMENSION=384 # Auto-detected if not specified
- Google: 768 (text-embedding-004, configurable with output_dimensionality parameter)
635
635
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.
637
637
638
638
### Ollama Configuration
639
639
@@ -919,7 +919,7 @@ flexible-graphrag
919
919
copy env-sample.txt .env # Windows
920
920
```
921
921
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.
923
923
924
924
**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).
925
925
@@ -1086,8 +1086,8 @@ Interactive conversational interface for document Q&A:
1086
1086
1087
1087
Between tests you can clean up data:
1088
1088
- **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
1091
1091
1092
1092
## MCP Server Setup (Quickstart)
1093
1093
@@ -1166,7 +1166,7 @@ The FastAPI backend provides the following REST API endpoints:
1166
1166
- **Swagger UI**: http://localhost:8000/docs
1167
1167
- **ReDoc**: http://localhost:8000/redoc
1168
1168
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.
1170
1170
1171
1171
## Full-Stack Debugging (Standalone Mode)
1172
1172
@@ -1230,7 +1230,7 @@ Flexible GraphRAG includes comprehensive observability features for production m
1230
1230
</a>
1231
1231
</p>
1232
1232
1233
-
See [docs/OBSERVABILITY/OBSERVABILITY.md](docs/OBSERVABILITY/OBSERVABILITY.md) forcomplete setup, custom instrumentation, and production best practices.
1233
+
See [docs/DEVELOPER/OBSERVABILITY/OBSERVABILITY.md](docs/DEVELOPER/OBSERVABILITY/OBSERVABILITY.md) forcomplete setup, custom instrumentation, and production best practices.
0 commit comments