UI port - #3
Conversation
…ettings - Enhanced `.env.example` and `docker-compose.yml` to include memory configuration options for Neo4j, allowing users to specify heap and page cache sizes for improved performance with large datasets. - Updated `README.md` to reflect these changes and provide clearer instructions for setting up the environment. - Improved the `docs_autopilot_enhanced.py` script to gather comprehensive context for documentation generation, ensuring accurate and up-to-date information is included. These updates enhance the usability and performance of the TriBridRAG system, particularly for users working with large corpora.
…details - Updated `mkdocs.yml` to improve site description, copyright information, and theme settings, including a new color palette and font specifications. - Refined the navigation structure in the documentation to provide clearer access to key topics, including architecture, retrieval, and configuration. - Enhanced the `index.md` file with a more concise overview of TriBridRAG, emphasizing the tri-brid retrieval approach and its components. - Removed outdated documentation files related to API endpoints and model configurations to streamline content and focus on current features. - Improved the overall organization and clarity of the documentation, ensuring it aligns with the latest system architecture and user needs. These changes enhance the usability and accessibility of the TriBridRAG documentation, making it easier for users to understand and navigate the system's capabilities.
|
This pull request makes significant improvements to the project's documentation infrastructure and user/developer documentation, as well as enhancements to Neo4j configuration for better memory management. The changes introduce automated documentation generation and deployment, modernize and enrich the MkDocs configuration, and provide detailed, user-friendly guides for API, architecture, and configuration. Additionally, Neo4j's memory settings are now more configurable and better documented for large-scale deployments. Documentation automation and content improvements:
Neo4j configuration enhancements:
These changes collectively improve developer onboarding, operational clarity, and the maintainability of both the documentation and the Neo4j service configuration. |
This pull request makes significant improvements to the project's documentation infrastructure and user/developer documentation, as well as enhancements to Neo4j configuration for better memory management. The changes introduce automated documentation generation and deployment, modernize and enrich the MkDocs configuration, and provide detailed, user-friendly guides for API, architecture, and configuration. Additionally, Neo4j's memory settings are now more configurable and better documented for large-scale deployments. **Documentation automation and content improvements:** * Adds a new GitHub Actions workflow (`.github/workflows/docs-automation.yml`) to automate documentation generation using AI, build with MkDocs, and deploy updates to GitHub Pages, including an option to regenerate all docs via workflow dispatch. * Substantially updates `mkdocs.yml` with a new site description, improved theme palette, enhanced navigation, additional plugins and markdown extensions, and a reorganized navigation structure for better user experience. * Introduces new, richly formatted documentation pages for API (`mkdocs/docs/api.md`), architecture (`mkdocs/docs/architecture.md`), and configuration (`mkdocs/docs/configuration.md`), featuring code samples, tables, diagrams, and best practices. [[1]](diffhunk://#diff-a4a4fb6b18f0d1706e211c585b6d4f96d3c2114336e0a1fcfd2c91ddc4635553R1-R128) [[2]](diffhunk://#diff-37d81208e840447c9b6382e9c2cd848b743124f5253d2b2eb4c3465f8ef11b16R1-R138) [[3]](diffhunk://#diff-497e037708cc64870c6ba9372f6064a69ca1e74d65d6195dcee5a44851e8b47dR1-R148) **Neo4j configuration enhancements:** * Documents and exposes Neo4j memory settings (`NEO4J_HEAP_INIT`, `NEO4J_HEAP_MAX`, `NEO4J_PAGECACHE`) in both `.env.example` and `docker-compose.yml`, allowing for easier tuning and improved performance on large corpora. [[1]](diffhunk://#diff-a3046da0d15a27e89f2afe639b25748a7ad4d9290af3e7b1b6c1a5533c8f0a8cR27-R32) [[2]](diffhunk://#diff-e45e45baeda1c1e73482975a664062aa56f20c03dd9d64a827aba57775bed0d3R36-R43) These changes collectively improve developer onboarding, operational clarity, and the maintainability of both the documentation and the Neo4j service configuration.
…its of index edits Review follow-up (P2-1, P2-2). Every config surface now STAGES through one path and Apply is the single write; the debounce machinery (patchSection, patchSectionDebounced, flushSection, cancelPendingPatches and their pending/timer state) is deleted because it has no callers left. - Converted the remaining immediate writers to `stageSection` (granted files): the per-field save and raw section overwrite in `useConfigFieldSave` (configControlPlane), the Sidepanel model-apply (embedding/reranking/generation), and EvalAnalysisTab's run settings. This removes the wholesale section-replace that could drop another surface's staged edit (P2-2 finding #3): no surface replaces a whole section on a per-section write any more. - Added `stageSectionReplace` for the Raw Section Editor (whole-section replace, no merge) so a key deleted from the raw JSON is actually dropped; its Save now stages and its copy says so (no reload-after-save that would discard the staged replace). - `flushPendingPatches` (Index Now, Paths save) now THROWS if the staged edits touch chunking/embedding/tokenization — the operator must Apply (which confirms the re-index) or discard first — so an index-invalidating change never commits silently through a side door (P2-1). Non-index staged edits still persist so the action reads them. - Any 409 (structured index-contract or generic conflict) now offers the reload-and-retry affordance. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This pull request makes significant improvements to the project's documentation infrastructure and user/developer documentation, as well as enhancements to Neo4j configuration for better memory management. The changes introduce automated documentation generation and deployment, modernize and enrich the MkDocs configuration, and provide detailed, user-friendly guides for API, architecture, and configuration. Additionally, Neo4j's memory settings are now more configurable and better documented for large-scale deployments.
Documentation automation and content improvements:
.github/workflows/docs-automation.yml) to automate documentation generation using AI, build with MkDocs, and deploy updates to GitHub Pages, including an option to regenerate all docs via workflow dispatch.mkdocs.ymlwith a new site description, improved theme palette, enhanced navigation, additional plugins and markdown extensions, and a reorganized navigation structure for better user experience.mkdocs/docs/api.md), architecture (mkdocs/docs/architecture.md), and configuration (mkdocs/docs/configuration.md), featuring code samples, tables, diagrams, and best practices. [1] [2] [3]Neo4j configuration enhancements:
NEO4J_HEAP_INIT,NEO4J_HEAP_MAX,NEO4J_PAGECACHE) in both.env.exampleanddocker-compose.yml, allowing for easier tuning and improved performance on large corpora. [1] [2]These changes collectively improve developer onboarding, operational clarity, and the maintainability of both the documentation and the Neo4j service configuration.