From 9e8984a7f3cf58977d26bb659004f4490271d165 Mon Sep 17 00:00:00 2001 From: Srihari Thyagarajan Date: Thu, 13 Nov 2025 14:13:48 +0530 Subject: [PATCH 1/2] Update note to support GitHub rendering Signed-off-by: Srihari Thyagarajan --- examples/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/examples/README.md b/examples/README.md index ac618127a..6163f67e7 100644 --- a/examples/README.md +++ b/examples/README.md @@ -52,8 +52,6 @@ Check out our [examples documentation](https://cocoindex.io/docs/examples) for m - 🛍️ [**product_recommendation**](./product_recommendation) - Build real-time recommendation engine with LLM and graph database ---- - -> **Note**: New to CocoIndex? Check out the [Getting Started](https://cocoindex.io/docs/getting_started) guide first! -> -> **Contribute**: We welcome contributions! Submit a [pull request](https://github.com/cocoindex-io/cocoindex/pulls) to add more examples. +> [!NOTE] +> New to CocoIndex? Check out the [Getting Started](https://cocoindex.io/docs/getting_started) guide first! +We also welcome contributions! Submit a [pull request](https://github.com/cocoindex-io/cocoindex/pulls) to add more examples. From bbfa3c98a1adf2682c8c0aa62446a7346ad7b92f Mon Sep 17 00:00:00 2001 From: Srihari Thyagarajan Date: Fri, 5 Dec 2025 08:40:31 +0530 Subject: [PATCH 2/2] `docs`: add `prerequisite` admonition note for having Postgres server running before launching cocoindex --- docs/docs/getting_started/quickstart.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs/getting_started/quickstart.md b/docs/docs/getting_started/quickstart.md index c609c9f22..f2c2f7445 100644 --- a/docs/docs/getting_started/quickstart.md +++ b/docs/docs/getting_started/quickstart.md @@ -144,6 +144,12 @@ CocoIndex supports other vector databases as well, with 1-line switch. export COCOINDEX_DATABASE_URL="postgresql://cocoindex:cocoindex@localhost:5432/cocoindex" ``` +:::info Prerequisite + +Make sure your Postgres server is running before proceeding. See [how to launch CocoIndex](../core/settings#configure-cocoindex-settings) for details. + +::: + - Build the index: ```sh