From 68730f4f6a6990c6268c823debc1e51b17d4b0d0 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sat, 8 Mar 2025 12:39:09 -0800 Subject: [PATCH 01/20] Add github to doc navbar --- docs/docusaurus.config.ts | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index f9dcbe41d..ec0768e04 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -75,8 +75,13 @@ const config: Config = { target: '_self' // This makes the logo click follow the link in the same window }, items: [ - { to: '/docs/', label: 'Documentation', position: 'right', target: '_self' }, - { to: 'https://cocoindex.io/blogs/', label: 'Blog', position: 'right', target: '_self' }, + { to: '/docs/', label: 'Documentation', position: 'left', target: '_self' }, + { to: 'https://cocoindex.io/blogs/', label: 'Blog', position: 'left', target: '_self' }, + { + href: 'https://github.com/cocoindex-io/cocoindex', + label: 'GitHub', + position: 'right', + }, ], }, footer: { From ad05e9dbdbe38fcf92baf665458822640bd507e5 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sat, 8 Mar 2025 21:49:48 -0800 Subject: [PATCH 02/20] Don't autoplay the quick start video --- docs/docs/getting_started/quickstart.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs/getting_started/quickstart.md b/docs/docs/getting_started/quickstart.md index c7b4b25f7..2557d47a4 100644 --- a/docs/docs/getting_started/quickstart.md +++ b/docs/docs/getting_started/quickstart.md @@ -12,8 +12,7 @@ This guide will help you get up and running with CocoIndex in just a few minutes * Perform basic chunking and embedding * loads the data into a vector store (PG Vector) - - + ## Prerequisite: Install CocoIndex environment From 4fba3c49fb7a23a087d634bebdd97075b75d7406 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 00:17:35 -0800 Subject: [PATCH 03/20] git and discord badge --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9cd751021..9f0c94761 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,13 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

[![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) +[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/stargazers) [![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) [![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) [![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) [![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) [![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) -[![Discord](https://img.shields.io/badge/discord-cocoindex-5B5BD6?logo=discord&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) +[![Discord](https://img.shields.io/discord/1314801574169673738?color=5B5BD6&logo=discord&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) From bc92ff1929701fd98545a938bc7ac1f4fdf353ff Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 00:21:49 -0800 Subject: [PATCH 04/20] Update README.md --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9f0c94761..c6a5335dc 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,24 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

-[![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) -[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/stargazers) -[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) -[![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) -[![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) -[![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) -[![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) -[![Discord](https://img.shields.io/discord/1314801574169673738?color=5B5BD6&logo=discord&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) -[![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) -[![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) +

+ GitHub + License + PyPI version + Python +

+ +

+ CI + release + docs +

+ +

+ Discord + LinkedIn + X (Twitter) +

CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing.

From 98613293cebad59a95aa2037fd144e1c37ef8b45 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 00:26:11 -0800 Subject: [PATCH 05/20] Update README.md --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index c6a5335dc..a2bf1745e 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,9 @@ License PyPI version Python -

- -

CI release docs -

- -

Discord LinkedIn X (Twitter) From 9b7fabc50897d557baa45eda01897ddadb0e6d42 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 00:44:35 -0800 Subject: [PATCH 06/20] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a2bf1745e..850764dc6 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,10 @@ License PyPI version Python - CI - release - docs - Discord + CI + release + docs + Discord LinkedIn X (Twitter)

From 82f9e192cde51462ad23b8df8a12016ad82e3be8 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 00:46:25 -0800 Subject: [PATCH 07/20] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 850764dc6..88b6cf18e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

- GitHub + GitHub License PyPI version Python From 41954790e63a3c7ca3ee4cb52416d443bdc6b687 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 15:49:13 -0700 Subject: [PATCH 08/20] installation --- docs/docs/getting_started/installation.md | 34 +++++++++++++++++++++++ docs/sidebars.ts | 1 + 2 files changed, 35 insertions(+) create mode 100644 docs/docs/getting_started/installation.md diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md new file mode 100644 index 000000000..d4035294b --- /dev/null +++ b/docs/docs/getting_started/installation.md @@ -0,0 +1,34 @@ +--- +title: Installation +description: Setup the CocoIndex environment in 0-3 min +--- + +## 🐍 Python and Pip +To follow the steps in this guide, you'll need: + +To install Python 3.10 or higher. Python 3.12 is recommended. +To install pip, a Python package installer + + +## 🌴 Install CocoIndex +```bash +pip install cocoindex +``` + +## 📦 Install Postgres + +You can skip this step if you already have a Postgres database with pgvector extension installed. + +If you don't have a Postgres database: + +1. Make sure Docker Compose 🐳 is installed: [docs](https://docs.docker.com/compose/install/) +2. Start a Postgres SQL database for cocoindex using our docker compose config: + +```bash +docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/postgres.yaml) up -d +``` + +## 🎉 All set! + +You can now start using CocoIndex. + diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 7ea953e57..489433e70 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -9,6 +9,7 @@ const sidebars: SidebarsConfig = { items: [ 'getting_started/overview', 'getting_started/quickstart', + 'getting_started/installation', ], }, { From 0d6267fc24cf7153faaf0aeb71356b838ca70886 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:01:16 -0700 Subject: [PATCH 09/20] polish readme and update installation with python/pip version and installation --- README.md | 20 ++++++++++---------- docs/docs/getting_started/installation.md | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 88b6cf18e..9cf0f5c0b 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,16 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

- GitHub - License - PyPI version - Python - CI - release - docs - Discord - LinkedIn - X (Twitter) + [![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) + [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) + [![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) + [![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) + [![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) + [![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) + [![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) + [![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) + [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) + [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io)

CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing. diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md index d4035294b..dc19bd297 100644 --- a/docs/docs/getting_started/installation.md +++ b/docs/docs/getting_started/installation.md @@ -6,8 +6,8 @@ description: Setup the CocoIndex environment in 0-3 min ## 🐍 Python and Pip To follow the steps in this guide, you'll need: -To install Python 3.10 or higher. Python 3.12 is recommended. -To install pip, a Python package installer +1. Install [Python](https://www.python.org/downloads/). We support Python 3.11 to 3.13 [![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/). +2. Install [pip](https://pip.pypa.io/en/stable/installation/) - a Python package installer ## 🌴 Install CocoIndex From db57493108788da594cf04b7c3e361a16be208a4 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:02:26 -0700 Subject: [PATCH 10/20] Update installation.md --- docs/docs/getting_started/installation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md index dc19bd297..b0b2eb280 100644 --- a/docs/docs/getting_started/installation.md +++ b/docs/docs/getting_started/installation.md @@ -6,7 +6,8 @@ description: Setup the CocoIndex environment in 0-3 min ## 🐍 Python and Pip To follow the steps in this guide, you'll need: -1. Install [Python](https://www.python.org/downloads/). We support Python 3.11 to 3.13 [![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/). +1. Install [Python](https://www.python.org/downloads/). We support Python 3.11 to 3.13 +[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/). 2. Install [pip](https://pip.pypa.io/en/stable/installation/) - a Python package installer From 4a382dd4e18107811d73bd4141809d63f47bc683 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:03:19 -0700 Subject: [PATCH 11/20] Update installation.md --- docs/docs/getting_started/installation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md index b0b2eb280..a08fed8ba 100644 --- a/docs/docs/getting_started/installation.md +++ b/docs/docs/getting_started/installation.md @@ -6,8 +6,7 @@ description: Setup the CocoIndex environment in 0-3 min ## 🐍 Python and Pip To follow the steps in this guide, you'll need: -1. Install [Python](https://www.python.org/downloads/). We support Python 3.11 to 3.13 -[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/). +1. Install [Python](https://www.python.org/downloads/). We support Python 3.11 to 3.13. 2. Install [pip](https://pip.pypa.io/en/stable/installation/) - a Python package installer From cd8be306e409382ecc3b1d1bb79b11d3f1b19cf9 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:04:50 -0700 Subject: [PATCH 12/20] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9cf0f5c0b..e77a061cd 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,18 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

-

- [![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) - [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) - [![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) - [![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) - [![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) - [![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) - [![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) - [![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) - [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) - [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) -

+
+[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) +[![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) +[![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) +[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) +[![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) +[![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) +[![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) +[![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) +[![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) +[![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) +
CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing.

From 3b5944a00cefe18c364eb2ad3dbc81f7ae1de7ec Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:06:29 -0700 Subject: [PATCH 13/20] Update README.md --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e77a061cd..9cf0f5c0b 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,18 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

-
-[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) -[![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) -[![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) -[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) -[![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) -[![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) -[![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) -[![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) -[![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) -[![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) -
+

+ [![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) + [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) + [![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) + [![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) + [![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) + [![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) + [![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) + [![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) + [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) + [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) +

CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing.

From ec7681fa9d089f1931f03725d3db1236cd30704a Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:07:39 -0700 Subject: [PATCH 14/20] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9cf0f5c0b..e7c38fdd2 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

+ [![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) [![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) @@ -15,6 +16,7 @@ [![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) +

CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing. From 42ab96dae7dac60cc3e4b0c38d0460a540668712 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:08:05 -0700 Subject: [PATCH 15/20] Update installation.md --- docs/docs/getting_started/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md index a08fed8ba..4ce9efd63 100644 --- a/docs/docs/getting_started/installation.md +++ b/docs/docs/getting_started/installation.md @@ -6,7 +6,7 @@ description: Setup the CocoIndex environment in 0-3 min ## 🐍 Python and Pip To follow the steps in this guide, you'll need: -1. Install [Python](https://www.python.org/downloads/). We support Python 3.11 to 3.13. +1. Install [Python](https://wiki.python.org/moin/BeginnersGuide/Download/). We support Python 3.11 to 3.13. 2. Install [pip](https://pip.pypa.io/en/stable/installation/) - a Python package installer From 3c422ceb1ba353af2ff0636f7ad97148d7db6094 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:08:56 -0700 Subject: [PATCH 16/20] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e7c38fdd2..38f85cfcb 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,16 @@

- [![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) - [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) - [![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) - [![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) - [![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) - [![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) - [![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) - [![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) - [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) - [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) +[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) +[![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) +[![PyPI version](https://img.shields.io/pypi/v/cocoindex?color=5B5BD6)](https://pypi.org/project/cocoindex/) +[![Python](https://img.shields.io/badge/python-3.11%20to%203.13-5B5BD6?logo=python&logoColor=white)](https://www.python.org/) +[![CI](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/CI.yml) +[![release](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/release.yml) +[![docs](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml/badge.svg?event=push&color=5B5BD6)](https://github.com/cocoindex-io/cocoindex/actions/workflows/docs.yml) +[![Discord](https://img.shields.io/discord/1314801574169673738?logo=discord&color=5B5BD6&logoColor=white)](https://discord.com/invite/zpA9S2DR7s) +[![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) +[![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io)

From 0fe21aa19a756071a5def015c2d7c62f7e986212 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:09:43 -0700 Subject: [PATCH 17/20] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 38f85cfcb..27b241e59 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

-

+

[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) @@ -17,7 +17,7 @@ [![LinkedIn](https://img.shields.io/badge/LinkedIn-CocoIndex-5B5BD6?logo=linkedin&logoColor=white)](https://www.linkedin.com/company/cocoindex) [![X (Twitter)](https://img.shields.io/twitter/follow/cocoindex_io)](https://twitter.com/intent/follow?screen_name=cocoindex_io) -

+
CocoIndex is the world's first open-source engine that supports both custom transformation logic and incremental updates specialized for data indexing.

From 179801bbada7139df3cfe408b69d0b87bfba749c Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:27:11 -0700 Subject: [PATCH 18/20] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 27b241e59..dc5e1ce6b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

Extract, Transform, Index Data. Easy and Fresh. 🌴

-
+
[![GitHub](https://img.shields.io/github/stars/cocoindex-io/cocoindex?color=5B5BD6)](https://github.com/cocoindex-io/cocoindex) [![License](https://img.shields.io/badge/license-Apache%202.0-5B5BD6?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/Apache-2.0) From 764ccbcf4b7bd4a0cdd974980586a89b4ceccc6d Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:36:30 -0700 Subject: [PATCH 19/20] Update installation.md --- docs/docs/getting_started/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md index 4ce9efd63..f7b0c9ec6 100644 --- a/docs/docs/getting_started/installation.md +++ b/docs/docs/getting_started/installation.md @@ -21,7 +21,7 @@ You can skip this step if you already have a Postgres database with pgvector ext If you don't have a Postgres database: -1. Make sure Docker Compose 🐳 is installed: [docs](https://docs.docker.com/compose/install/) +1. Install [Docker](https://docs.docker.com/compose/install/) 🐳. 2. Start a Postgres SQL database for cocoindex using our docker compose config: ```bash From 49a66d95ac82ef89f249eb1e3bdc1e446f164e36 Mon Sep 17 00:00:00 2001 From: Linghua Jin Date: Sun, 9 Mar 2025 16:50:02 -0700 Subject: [PATCH 20/20] Update installation.md --- docs/docs/getting_started/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/getting_started/installation.md b/docs/docs/getting_started/installation.md index f7b0c9ec6..e2854288a 100644 --- a/docs/docs/getting_started/installation.md +++ b/docs/docs/getting_started/installation.md @@ -21,7 +21,7 @@ You can skip this step if you already have a Postgres database with pgvector ext If you don't have a Postgres database: -1. Install [Docker](https://docs.docker.com/compose/install/) 🐳. +1. Install [Docker Compose](https://docs.docker.com/compose/install/) 🐳. 2. Start a Postgres SQL database for cocoindex using our docker compose config: ```bash