From 5c92d804babf1e1ef852872dd3896eacd0755908 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Tue, 15 Apr 2025 14:46:24 -0700 Subject: [PATCH 1/9] update cocoindex version for examples --- examples/code_embedding/pyproject.toml | 2 +- examples/docs_to_kg/pyproject.toml | 2 +- examples/gdrive_text_embedding/pyproject.toml | 2 +- examples/manuals_llm_extraction/pyproject.toml | 2 +- examples/pdf_embedding/pyproject.toml | 2 +- examples/text_embedding/pyproject.toml | 2 +- examples/text_embedding_qdrant/pyproject.toml | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/examples/code_embedding/pyproject.toml b/examples/code_embedding/pyproject.toml index 41b7d919..dc55508f 100644 --- a/examples/code_embedding/pyproject.toml +++ b/examples/code_embedding/pyproject.toml @@ -3,4 +3,4 @@ name = "code-embedding" version = "0.1.0" description = "Simple example for cocoindex: build embedding index based on source code." requires-python = ">=3.10" -dependencies = ["cocoindex>=0.1.19", "python-dotenv>=1.0.1"] +dependencies = ["cocoindex>=0.1.20", "python-dotenv>=1.0.1"] diff --git a/examples/docs_to_kg/pyproject.toml b/examples/docs_to_kg/pyproject.toml index fc2964af..2a52794d 100644 --- a/examples/docs_to_kg/pyproject.toml +++ b/examples/docs_to_kg/pyproject.toml @@ -3,4 +3,4 @@ name = "manuals-to-kg" version = "0.1.0" description = "Simple example for cocoindex: extract triples from files and build knowledge graph." requires-python = ">=3.10" -dependencies = ["cocoindex>=0.1.19", "python-dotenv>=1.0.1"] +dependencies = ["cocoindex>=0.1.20", "python-dotenv>=1.0.1"] diff --git a/examples/gdrive_text_embedding/pyproject.toml b/examples/gdrive_text_embedding/pyproject.toml index 964a2757..55835a9a 100644 --- a/examples/gdrive_text_embedding/pyproject.toml +++ b/examples/gdrive_text_embedding/pyproject.toml @@ -3,4 +3,4 @@ name = "gdrive-text-embedding" version = "0.1.0" description = "Simple example for cocoindex: build embedding index based on Google Drive files." requires-python = ">=3.11" -dependencies = ["cocoindex>=0.1.19", "python-dotenv>=1.0.1"] +dependencies = ["cocoindex>=0.1.20", "python-dotenv>=1.0.1"] diff --git a/examples/manuals_llm_extraction/pyproject.toml b/examples/manuals_llm_extraction/pyproject.toml index e098da92..7751126b 100644 --- a/examples/manuals_llm_extraction/pyproject.toml +++ b/examples/manuals_llm_extraction/pyproject.toml @@ -4,7 +4,7 @@ version = "0.1.0" description = "Simple example for cocoindex: extract structured information from a Markdown file using LLM." requires-python = ">=3.10" dependencies = [ - "cocoindex>=0.1.19", + "cocoindex>=0.1.20", "python-dotenv>=1.0.1", "marker-pdf>=1.5.2", ] diff --git a/examples/pdf_embedding/pyproject.toml b/examples/pdf_embedding/pyproject.toml index 93b03bcb..cd5ae878 100644 --- a/examples/pdf_embedding/pyproject.toml +++ b/examples/pdf_embedding/pyproject.toml @@ -4,7 +4,7 @@ version = "0.1.0" description = "Simple example for cocoindex: build embedding index based on local PDF files." requires-python = ">=3.10" dependencies = [ - "cocoindex>=0.1.19", + "cocoindex>=0.1.20", "python-dotenv>=1.0.1", "marker-pdf>=1.5.2", ] diff --git a/examples/text_embedding/pyproject.toml b/examples/text_embedding/pyproject.toml index 8546886d..95bff7bb 100644 --- a/examples/text_embedding/pyproject.toml +++ b/examples/text_embedding/pyproject.toml @@ -3,4 +3,4 @@ name = "text-embedding" version = "0.1.0" description = "Simple example for cocoindex: build embedding index based on local text files." requires-python = ">=3.10" -dependencies = ["cocoindex>=0.1.19", "python-dotenv>=1.0.1"] +dependencies = ["cocoindex>=0.1.20", "python-dotenv>=1.0.1"] diff --git a/examples/text_embedding_qdrant/pyproject.toml b/examples/text_embedding_qdrant/pyproject.toml index 1505d902..ec1b4c40 100644 --- a/examples/text_embedding_qdrant/pyproject.toml +++ b/examples/text_embedding_qdrant/pyproject.toml @@ -3,4 +3,4 @@ name = "text-embedding-qdrant" version = "0.1.0" description = "Simple example for cocoindex: build embedding index based on local text files." requires-python = ">=3.10" -dependencies = ["cocoindex>=0.1.19", "python-dotenv>=1.0.1"] +dependencies = ["cocoindex>=0.1.20", "python-dotenv>=1.0.1"] From e8d0c55fdd339736b97fe1a8879c1c3ebcfd8068 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Tue, 15 Apr 2025 15:12:30 -0700 Subject: [PATCH 2/9] amend neo4j connection instruction in the local dev example --- examples/docs_to_kg/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/examples/docs_to_kg/README.md b/examples/docs_to_kg/README.md index 577c759b..2b70a08f 100644 --- a/examples/docs_to_kg/README.md +++ b/examples/docs_to_kg/README.md @@ -40,6 +40,12 @@ python main.py cocoindex update ### Browse the knowledge graph After the knowledge graph is build, you can explore the knowledge graph you built in Neo4j Browser. + +For the dev enviroment, you can connect neo4j browser using credentials: +- username: neo4j +- password: cocoindex +which is pre-configured in the our docker compose [config.yaml](https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/neo4j.yaml). + You can open it at [http://localhost:7474](http://localhost:7474), and run the following Cypher query to get all relationships: ```cypher From 76242fc3def70ccd21f6d64d61e7a3348ad29441 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Tue, 15 Apr 2025 15:55:23 -0700 Subject: [PATCH 3/9] Update README.md --- examples/docs_to_kg/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/docs_to_kg/README.md b/examples/docs_to_kg/README.md index 2b70a08f..b2b25798 100644 --- a/examples/docs_to_kg/README.md +++ b/examples/docs_to_kg/README.md @@ -42,8 +42,8 @@ python main.py cocoindex update After the knowledge graph is build, you can explore the knowledge graph you built in Neo4j Browser. For the dev enviroment, you can connect neo4j browser using credentials: -- username: neo4j -- password: cocoindex +- username: `neo4j` +- password: `cocoindex` which is pre-configured in the our docker compose [config.yaml](https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/neo4j.yaml). You can open it at [http://localhost:7474](http://localhost:7474), and run the following Cypher query to get all relationships: From f9c449ee33cd639bddf07facedd8ed512b584c31 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 20 Apr 2025 16:19:08 -0700 Subject: [PATCH 4/9] Improve contributing guide --- docs/docs/about/community.md | 4 ++-- docs/docs/about/contributing.md | 18 +++++++++++++++--- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/docs/about/community.md b/docs/docs/about/community.md index e0633ce4..ac577ff7 100644 --- a/docs/docs/about/community.md +++ b/docs/docs/about/community.md @@ -29,7 +29,7 @@ Join our community channels to get help, share ideas, and connect with other dev Need help? Here are the best ways to get support: -- Email us at [support@cocoindex.io](mailto:support@cocoindex.io) +- Email us at [hi@cocoindex.io](mailto:hi@cocoindex.io) - Check our [documentation](https://cocoindex.io/docs) - Read our [blog posts](https://cocoindex.io/blogs) -- Ask questions in our Discord community \ No newline at end of file +- Ask questions in our [Discord Server](https://discord.com/invite/zpA9S2DR7s) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 73925128..876b139f 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -5,9 +5,22 @@ description: Learn how to contribute to CocoIndex # Contributing -We love contributions from our community! This guide explains how to get involved and contribute to CocoIndex. +[CocoIndex](https://github.com/cocoindex-io/cocoindex) is an open source project. We love contributions from our community! We are respectful, open and friendly. This guide explains how to get involved and contribute to [CocoIndex](https://github.com/cocoindex-io/cocoindex). -## Setting Up Development Environment +## Issues: + +We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to track bugs and feature requests. + +## Good First Issues + +We tag issues with the ["good first issue"](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label for beginner contributors. + +## How to Contribute +- If you decide to work on an issue, please comment on the issue **`I'm working on it`** to helping other contributors avoid duplicating work. +- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, either leaving a message under a issue or asking in the discord server will work! + +## Start hacking! Setting Up Development Environment +Followinng the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. - Install Rust toolchain: [docs](https://rust-lang.org/tools/install) @@ -48,7 +61,6 @@ To submit your code: In your PR description, please include: - Description of the changes - Motivation and context -- Test coverage details - Note if it's a breaking change - Reference any related GitHub issues From 2db09cfdccc9022d1aea3fe5c28a1b395b925455 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 20 Apr 2025 17:29:31 -0700 Subject: [PATCH 5/9] Update contributing.md --- docs/docs/about/contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 876b139f..b90deda2 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -16,11 +16,11 @@ We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to trac We tag issues with the ["good first issue"](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label for beginner contributors. ## How to Contribute -- If you decide to work on an issue, please comment on the issue **`I'm working on it`** to helping other contributors avoid duplicating work. -- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, either leaving a message under a issue or asking in the discord server will work! +- If you decide to work on an issue, we recommend you to comment on the issue **`I'm working on it`** to helping other contributors avoid duplicating work. +- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, either leaving a message under an issue or asking in the discord server will work! ## Start hacking! Setting Up Development Environment -Followinng the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. +Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. - Install Rust toolchain: [docs](https://rust-lang.org/tools/install) From 6fa9b66f13235bad74d24576deb29f60a964a96e Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 20 Apr 2025 18:19:11 -0700 Subject: [PATCH 6/9] Update contributing.md --- docs/docs/about/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index b90deda2..ce9591c5 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -17,7 +17,7 @@ We tag issues with the ["good first issue"](https://github.com/cocoindex-io/coco ## How to Contribute - If you decide to work on an issue, we recommend you to comment on the issue **`I'm working on it`** to helping other contributors avoid duplicating work. -- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, either leaving a message under an issue or asking in the discord server will work! +- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, either leaving a message under a issue or asking in the discord server will work! ## Start hacking! Setting Up Development Environment Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. From 9b65256d47b6daac241002dedeb33ed7959015b4 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 20 Apr 2025 23:16:01 -0700 Subject: [PATCH 7/9] revised the message --- docs/docs/about/contributing.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index ce9591c5..34fae5b7 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -5,7 +5,7 @@ description: Learn how to contribute to CocoIndex # Contributing -[CocoIndex](https://github.com/cocoindex-io/cocoindex) is an open source project. We love contributions from our community! We are respectful, open and friendly. This guide explains how to get involved and contribute to [CocoIndex](https://github.com/cocoindex-io/cocoindex). +[CocoIndex](https://github.com/cocoindex-io/cocoindex) is an open source project. We are respectful, open and friendly. This guide explains how to get involved and contribute to [CocoIndex](https://github.com/cocoindex-io/cocoindex). ## Issues: @@ -16,8 +16,9 @@ We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to trac We tag issues with the ["good first issue"](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label for beginner contributors. ## How to Contribute -- If you decide to work on an issue, we recommend you to comment on the issue **`I'm working on it`** to helping other contributors avoid duplicating work. -- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, either leaving a message under a issue or asking in the discord server will work! +- If you decide to work on an issue, for changes that takes more than a day, we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`** to avoid duplicating work. +- For larger features, we recommend you to discuss with us first in our [discord server](https://discord.com/invite/zpA9S2DR7s) to coordinate the design and work. +- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly. ## Start hacking! Setting Up Development Environment Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out. From 095b7f261d2683621346e3ed8e4c4e5b3bec2973 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 20 Apr 2025 23:20:16 -0700 Subject: [PATCH 8/9] =?UTF-8?q?Update=20=F0=9F=92=A1-feature-request.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ".github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" | 4 ++++ 1 file changed, 4 insertions(+) diff --git "a/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" "b/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" index 2f553777..9f96bac3 100644 --- "a/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" +++ "b/.github/ISSUE_TEMPLATE/\360\237\222\241-feature-request.md" @@ -18,3 +18,7 @@ A clear and concise description of any alternative solutions or features you've **Additional context** Add any other context or screenshots about the feature request here. + +--- +[Contributing Guide](https://cocoindex.io/docs/about/contributing) +For changes that takes more than a day, we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`** to avoid duplicating work. From 7ea758b4d135b77e2ea1cf212f9379529315d9bb Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Mon, 21 Apr 2025 22:03:13 -0700 Subject: [PATCH 9/9] Update contributing.md --- docs/docs/about/contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/about/contributing.md b/docs/docs/about/contributing.md index 34fae5b7..a366c68c 100644 --- a/docs/docs/about/contributing.md +++ b/docs/docs/about/contributing.md @@ -16,9 +16,9 @@ We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to trac We tag issues with the ["good first issue"](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label for beginner contributors. ## How to Contribute -- If you decide to work on an issue, for changes that takes more than a day, we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`** to avoid duplicating work. -- For larger features, we recommend you to discuss with us first in our [discord server](https://discord.com/invite/zpA9S2DR7s) to coordinate the design and work. -- Our [discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly. +- If you decide to work on an issue, unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`** to avoid duplicating work. +- For larger features, we recommend you to discuss with us first in our [Discord server](https://discord.com/invite/zpA9S2DR7s) to coordinate the design and work. +- Our [Discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly. ## Start hacking! Setting Up Development Environment Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out.