Skip to content

Commit d567c99

Browse files
authored
docs: examples visual - cover images to all - make it easier to share too (#942)
1 parent 16b82c5 commit d567c99

File tree

14 files changed

+45
-19
lines changed

14 files changed

+45
-19
lines changed

docs/docs/examples/examples/academic_papers_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ tags: [vector-index, metadata]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/paper_metadata"/>
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/paper_metadata" margin="0 0 24px 0" />
16+
17+
![Academic Papers Index](/img/examples/academic_papers_index/cover.png)
1618

1719
## What we will achieve
1820

docs/docs/examples/examples/codebase_index.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ tags: [vector-index, codebase]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/code_embedding"/>
16-
<YouTubeButton url="https://youtu.be/G3WstvhHO24?si=ndYfM0XRs03_hVPR" />
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/code_embedding" margin="0 0 24px 0" />
16+
<YouTubeButton url="https://youtu.be/G3WstvhHO24?si=ndYfM0XRs03_hVPR" margin="0 0 24px 0" />
17+
18+
![Codebase Index](/img/examples/codebase_index/cover.png)
1719

1820
## Overview
1921
In this tutorial, we will build codebase index. [CocoIndex](https://github.com/cocoindex-io/cocoindex) provides built-in support for codebase chunking, with native Tree-sitter support. It works with large codebases, and can be updated in near real-time with incremental processing - only reprocess what's changed.
2022

2123
## Use Cases
22-
A wide range of applications can be built with an effective codebase index that is always up-to-date. Some examples include:
23-
24-
![Use case illustration](/img/examples/codebase_index/usecase.png)
24+
A wide range of applications can be built with an effective codebase index that is always up-to-date.
2525

2626
- Semantic code context for AI coding agents like Claude, Codex, Gemini CLI.
2727
- MCP for code editors such as Cursor, Windsurf, and VSCode.
2828
- Context-aware code search applications—semantic code search, natural language code retrieval.
2929
- Context for code review agents—AI code review, automated code analysis, code quality checks, pull request summarization.
3030
- Automated code refactoring, large-scale code migration.
31-
- Enhance SRE workflows: enable rapid root cause analysis, incident response, and change impact assessment by indexing infrastructure-as-code, deployment scripts, and config files for semantic search and lineage tracking.
31+
- SRE workflows: enable rapid root cause analysis, incident response, and change impact assessment by indexing infrastructure-as-code, deployment scripts, and config files for semantic search and lineage tracking.
3232
- Automatically generate design documentation from code—keep design docs up-to-date.
3333

3434
## Flow Overview
@@ -222,4 +222,11 @@ To spin up, it is super easy.
222222
```
223223
cocoindex server main.py -ci
224224
```
225-
Follow the url from the terminal - `https://cocoindex.io/cocoinsight` to access the CocoInsight.
225+
Follow the url from the terminal - `https://cocoindex.io/cocoinsight` to access the CocoInsight.
226+
227+
228+
## Supported Languages
229+
230+
SplitRecursively has native support for all major programming languages.
231+
232+
<DocumentationButton url="https://cocoindex.io/docs/ops/functions#supported-languages" text="Supported Languages" margin="0 0 16px 0" />

docs/docs/examples/examples/custom_targets.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ tags: [custom-building-blocks]
1111
---
1212
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1313

14-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/custom_output_files"/>
14+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/custom_output_files" margin="0 0 24px 0" />
15+
16+
![Custom Targets](/img/examples/custom_targets/cover.png)
1517

1618
## Overview
1719

docs/docs/examples/examples/docs_to_knowledge_graph.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ tags: [knowledge-graph, structured-data-extraction]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/docs_to_knowledge_graph"/>
16-
<YouTubeButton url="https://youtu.be/2KVkpUGRtnk?si=MRalDweWrid-IFje" />
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/docs_to_knowledge_graph" margin="0 0 24px 0" />
16+
<YouTubeButton url="https://youtu.be/2KVkpUGRtnk?si=MRalDweWrid-IFje" margin="0 0 24px 0" />
17+
18+
![Knowledge Graph for Docs](/img/examples/docs_to_knowledge_graph/cover.png)
1719

1820
## Overview
1921
[CocoIndex](https://github.com/cocoindex-io/cocoindex) makes it easy to build and maintain knowledge graphs with continuous source updates. In this tutorial, we will use LLM to extract relationships between the concepts in each document, and generate two kinds of relationships:

docs/docs/examples/examples/image_search.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ tags: [vector-index, multi-modal]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/image_search"/>
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/image_search" margin="0 0 24px 0" />
16+
17+
![Image Search](/img/examples/image_search/cover.png)
1618

1719
## Overview
1820
CocoIndex supports native integration with ColPali - with just a few lines of code, you embed and index images with ColPali’s late-interaction architecture. We also build a light weight image search application with FastAPI.

docs/docs/examples/examples/manual_extraction.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ tags: [structured-data-extraction, data-mapping]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/manuals_llm_extraction"/>
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/manuals_llm_extraction" margin="0 0 24px 0" />
16+
17+
![Manual Extraction](/img/examples/manual_extraction/cover.png)
1618

1719
## Overview
1820
This example shows how to extract structured data from Python Manuals using Ollama.

docs/docs/examples/examples/multi_format_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ tags: [vector-index, multi-modal]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/multi_format_indexing"/>
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/multi_format_indexing" margin="0 0 24px 0" />
16+
17+
![Multi Format Index](/img/examples/multi_format_index/cover.png)
1618

1719
## Overview
1820
Do you have a messy collection of scanned documents, PDFs, academic papers, presentation slides, and standalone images — all mixed together with charts, tables, and figures — that you want to process into the same vector space for semantic search or to power an AI agent?

docs/docs/examples/examples/patient_form_extraction.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ tags: [structured-data-extraction, data-mapping]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/patient_intake_extraction"/>
16-
<YouTubeButton url="https://youtu.be/_mjlwVtnBn0?si=-TBImMyZbnKh-5FB" />
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/patient_intake_extraction" margin="0 0 24px 0" />
16+
<YouTubeButton url="https://youtu.be/_mjlwVtnBn0?si=-TBImMyZbnKh-5FB" margin="0 0 24px 0" />
17+
18+
![Patient Form Extraction](/img/examples/patient_form_extraction/cover.png)
1719

1820
## Overview
1921
With CocoIndex, you can easily define nested schema in Python dataclass and use LLM to extract structured data from unstructured data. This example shows how to extract structured data from patient intake forms.

docs/docs/examples/examples/photo_search.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ tags: [vector-index, multi-modal]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/face_recognition"/>
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/face_recognition" margin="0 0 24px 0" />
16+
17+
![Photo Search](/img/examples/photo_search/cover.png)
1618

1719
## Overview
1820
We’ll walk through a comprehensive example of building a scalable face recognition pipeline. We’ll

docs/docs/examples/examples/product_recommendation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ tags: [knowledge-graph]
1212

1313
import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
1414

15-
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/product_recommendation"/>
15+
<GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/product_recommendation" margin="0 0 24px 0" />
16+
17+
![Product Recommendation](/img/examples/product_recommendation/cover.png)
1618

1719
## Overview
1820

0 commit comments

Comments
 (0)