[Doc] Refine the README for GraphRAG #1683

Activity

1. joshuayao

   added

   Backlog

   documentationImprovements or additions to documentationImprovements or additions to documentation

   on Mar 18, 2025
2. joshuayao

   added this to the v1.3 milestone on Mar 18, 2025
3. joshuayao

   added the

   Task

   issue type on Mar 18, 2025
4. joshuayao

   added a parent issue on Mar 18, 2025

   • [Doc] Refine README files for all examples in v1.4. #1673
5. lvliang-intel

   assigned

   yao531441

   on Mar 18, 2025
6. joshuayao

   removed this from the v1.3 milestone on Mar 25, 2025
7. joshuayao

   added this to the v1.4 milestone on Apr 14, 2025
8. edlee123 commented on Apr 22, 2025

   

   edlee123

   on Apr 22, 2025

   Last edited by edlee123

   Contributor

   More actions

   These are some inconsistencies in usage of environment variables between unit tests (works) and GraphRAG README.

   DATAPREP_PORT:

   GenAIComps/tests/dataprep/test_dataprep_neo4j_on_intel_hpu.sh: 11103.
   GenAIExamples/GraphRAG/README.md: Mentions both 11103 and 6007 for dataprep ingest (can use environment variable instead of hardcode).

   TEI_EMBEDDER_PORT:

   GenAIComps/tests/dataprep/test_dataprep_neo4j_on_intel_hpu.sh: 12006
   GenAIExamples/GraphRAG/README.md: 6006

   NEO4J_URI / NEO4J_URL:

   GenAIComps/tests/dataprep/test_dataprep_neo4j_on_intel_hpu.sh sets NEO4J_URL only.
   GenAIExamples/GraphRAG/README.md sets NEO4J_URI only.

   Note: "URI" vs "URL"

   NEO4J_PLUGINS:

   GenAIComps/tests/dataprep/test_dataprep_neo4j_on_intel_hpu.sh: Sets NEO4J_PLUGINS to ["apoc"].
   GenAIExamples/GraphRAG/README.md: Does not explicitly set or mention NEO4J_PLUGINS.

   NEO4J_PORT2:

   GenAIComps/tests/dataprep/test_dataprep_neo4j_on_intel_hpu.sh: Sets NEO4J_PORT2 to 7687 (and also mentions a commented-out alternative 11632).
   GenAIExamples/GraphRAG/README.md: Does not explicitly set NEO4J_PORT2, but it does mention it in the context of NEO4J_URI and in a table showing port 7687.
9. joshuayao

   added this to OPEAon Apr 22, 2025
10. joshuayao

    moved this to Not started in OPEAon May 6, 2025
11. joshuayao

    modified the milestones: v1.4, v1.5 on Jul 8, 2025