Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add troubleshooting guide and configuration validation #478

Closed
wants to merge 96 commits into from
Closed

Conversation

rik3k
Copy link

@rik3k rik3k commented Nov 10, 2024

Description

Type of change

  • New features (non-breaking change).
  • Bug fix (non-breaking change).
  • Breaking change (fix or feature that would cause existing functionality not to work as expected).

Checklist

  • I have performed a self-review of my code.
  • I have added thorough tests if it is a core feature.
  • There is a reference to the original bug report and related work.
  • I have commented on my code, particularly in hard-to-understand areas.
  • The feature is well documented.

Changes made:

  1. Added new docs/troubleshooting.md with structured sections for:
    • File processing issues
    • GraphRAG configuration
    • Document handling
    • UI/UX troubleshooting
  2. Created placeholder for configuration validation in libs/ktem/ktem/config/validator.py
  3. Updated README.md with known limitations and considerations

taprosoft and others added 30 commits August 26, 2024 09:52
Documentation Navigation URL Fix
* feat: Add PR template

* feat: Add issue templates

* style: Comfort pre-commit

* style: Comfort pre-commit
* feat: add test connection feature

* fix: typo
…#none)

* feat: reduce docker image size by removing unnecessary cache

* fix: trailing whitespace
* feat: add support for .md

* fix: disable download all on private collection
* fix: re-enable tests and fix legacy test interface

* fix: skip llamacpp based on installed status

* fix: minor fix
Signed-off-by: ChengZi <chen.zhang@zilliz.com>
* feat: update build push docker action

* feat: remove tag trigger

* feat: remove manual trigger

* fix: update workflow

* feat: update build-push-docker.yaml

* fix: update workflow

* fix: update workflow

* fix: update workflow

* refactor: comfort pre-commit

* feat: update permission

* feat: update docker support pdfjs

* refactor: comfort pre-commit
* fix: update on release event build push docker

* refactor: comfort pre-commit
* feat(windows installer): check and install git

* feat: update run_windows.bat

* feat: Replace standalone Git installer with Portable Git

* feat: support milvus vector db (#188) #none

Signed-off-by: ChengZi <chen.zhang@zilliz.com>

* feat: add github action to build docker for release  (#168) #none

* feat: update build push docker action

* feat: remove tag trigger

* feat: remove manual trigger

* fix: update workflow

* feat: update build-push-docker.yaml

* fix: update workflow

* fix: update workflow

* fix: update workflow

* refactor: comfort pre-commit

* feat: update permission

* feat: update docker support pdfjs

* refactor: comfort pre-commit

* feat: add support for Gemini, Claude through Langchain (#225) (bump:patch)

* fix: disable default install for google-genai package

* fix: disable default install for anthropic

* fix: update on release event build push docker (#228) #none

* fix: update on release event build push docker

* refactor: comfort pre-commit

* fix: limit fastapi version (#229)

* fix: update requirements (#230)

* style: fix pre-commit

---------

Signed-off-by: ChengZi <chen.zhang@zilliz.com>
Co-authored-by: ChengZi <chen.zhang@zilliz.com>
Co-authored-by: kan_cin <kan@cinnamon.is>
Co-authored-by: Tuan Anh Nguyen Dang (Tadashi_Cin) <tadashi@cinnamon.is>
taprosoft and others added 28 commits October 10, 2024 14:44
* fix: toggle graphrag install in Docker build

* fix: update Dockerfile

* fix: remove unused logics in chat_fn

* fix: disable duckduckgo test due to API limit
* fix: multiplatform build

* fix: test build
* allow to use customized GraphRAG settings.yaml

* adjust import style

* fix typo

* Added GraphRAG original documentation reference.

* feat: allow to use customized GraphRAG settings.yaml
(#387)

---------

Co-authored-by: Chen, Ron Gang <git@git.com>
* feat: add web URL loader & refine indexing logics

* fix: comfort mypy
* Update adobe_loader.py

fix:When initializing the Document, extra_info was not added to the metadata.

* Update adobe_loader.py

Change the method of checking whether extra_info is None.
* docs: update README.md

* feat: prettify commit

* docs: prettify commit

* fix: trim trailing whitespace and prettier

* docs: minor update

* docs: update resources

* docs: minor update

---------

Co-authored-by: Tadashi <tadashi@cinnamon.is>
* feat: add toggle dark mode button on main UI

* docs: update docs
* add nano graph-rag

* ignore entities for relevant context reference

* refactor and add local model as default nano-graphrag

* feat: add kotaemon llm & embedding integration with nanographrag

* fix: add env var for nano GraphRAG

---------

Co-authored-by: Tadashi <tadashi@cinnamon.is>
* feat:support for visualizing citation results (via embeddings)

Signed-off-by: Kennywu <jdlow@live.cn>

* fix: remove ktem dependency in visualize_cited

* fix: limit onnx version for fastembed

* fix: test case of indexing

* fix: minor update

* fix: chroma req

* fix: chroma req

---------

Signed-off-by: Kennywu <jdlow@live.cn>
Co-authored-by: Tadashi <tadashi@cinnamon.is>
Co-authored-by: Tadashi <tadashi@cinnamon.is>
* feat: add lightrag support

* docs: update README
* feat: update docker build for lightrag

* feat: update docker build

* feat: update docker build
- Add new troubleshooting.md with sections for file processing, GraphRAG, document handling, and UI/UX issues
- Document solutions for reported issues #476, #447, #451, #449, #438, #466, and #469
- Improve user guidance for error resolution and system configuration
@cin-jimmy cin-jimmy requested a review from taprosoft November 10, 2024 02:15
@rik3k rik3k closed this Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.