Skip to content

Commit d2e4f0d

Browse files
rahlkrahlk
committed
Add CNAME to codellm-devkit.info
Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
2 parents 2540256 + 5226d0d commit d2e4f0d

289 files changed

Lines changed: 31811 additions & 795 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/mkdocs-deploy.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ on:
33
push:
44
branches:
55
- docs
6-
- main
76

87
permissions:
98
contents: write

‎README.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<!-- # CodeLLM-Devkit: A Python library for seamless interaction with CodeLLMs -->
21
<picture>
32
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/images/cldk-dark.png">
43
<source media="(prefers-color-scheme: light)" srcset="docs/assets/images/cldk-light.png">
@@ -7,43 +6,43 @@
76

87
<p align='center'>
98
<a href="https://arxiv.org/abs/2410.13007">
10-
<img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=flat-square" />
9+
<img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=for-the-badge" />
1110
</a>
1211
<a href="https://www.python.org/downloads/release/python-3110/">
13-
<img src="https://img.shields.io/badge/python-3.11-blue?style=flat-square" />
12+
<img src="https://img.shields.io/badge/python-3.11-blue?style=for-the-badge" />
1413
</a>
1514
<a href="https://opensource.org/licenses/Apache-2.0">
16-
<img src="https://img.shields.io/badge/License-Apache%202.0-green?style=flat-square" />
15+
<img src="https://img.shields.io/badge/License-Apache%202.0-green?style=for-the-badge" />
1716
</a>
1817
<a href="https://ibm.github.io/codellm-devkit/">
19-
<img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=flat-square" />
18+
<img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=for-the-badge" />
2019
</a>
2120
<a href="https://badge.fury.io/py/cldk">
22-
<img src="https://img.shields.io/pypi/v/cldk?style=flat-square&label=codellm-devkit&color=blue" />
21+
<img src="https://img.shields.io/pypi/v/cldk?style=for-the-badge&label=codellm-devkit&color=blue" />
2322
</a>
2423
<a href="https://discord.gg/zEjz9YrmqN">
25-
<img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=flat-square"/>
24+
<img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=for-the-badge"/>
2625
</a>
2726
</p>
2827

29-
Codellm-devkit (CLDK) is a multilingual program analysis framework that bridges the gap between traditional static analysis tools and Large Language Models (LLMs) specialized for code (CodeLLMs). Codellm-devkit allows developers to streamline the process of transforming raw code into actionable insights by providing a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs.
28+
Codellm-Devkit (CLDK) is a multilingual program analysis framework that bridges the gap between traditional static analysis tools and Large Language Models (LLMs) specialized for code (CodeLLMs). Codellm-Devkit allows developers to streamline the process of transforming raw code into actionable insights by providing a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs.
3029

31-
Codellm-devkit simplifies the complex process of analyzing codebases that span multiple programming languages, making it easier to extract meaningful insights and drive LLM-based code analysis. `CLDK` achieves this through an open-source Python library that abstracts the intricacies of program analysis and LLM interactions. With this library, developer can streamline the process of transforming raw code into actionable insights by providing a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs.
30+
Codellm-Devkit simplifies the complex process of analyzing codebases that span multiple programming languages, making it easier to extract meaningful insights and drive LLM-based code analysis. `CLDK` achieves this through an open-source Python library that abstracts the intricacies of program analysis and LLM interactions. With this library, developer can streamline the process of transforming raw code into actionable insights by providing a unified interface for integrating outputs from various analysis tools and preparing them for effective use by CodeLLMs.
3231

33-
**The purpose of Codellm-devkit is to enable the development and experimentation of robust analysis pipelines that harness the power of both traditional program analysis tools and CodeLLMs.**
34-
By providing a consistent and extensible framework, Codellm-devkit aims to reduce the friction associated with multi-language code analysis and ensure compatibility across different analysis tools and LLM platforms.
32+
**The purpose of Codellm-Devkit is to enable the development and experimentation of robust analysis pipelines that harness the power of both traditional program analysis tools and CodeLLMs.**
33+
By providing a consistent and extensible framework, Codellm-Devkit aims to reduce the friction associated with multi-language code analysis and ensure compatibility across different analysis tools and LLM platforms.
3534

36-
Codellm-devkit is designed to integrate seamlessly with a variety of popular analysis tools, such as WALA, Tree-sitter, LLVM, and CodeQL, each implemented in different languages. Codellm-devkit acts as a crucial intermediary layer, enabling efficient and consistent communication between these tools and the CodeLLMs.
35+
Codellm-Devkit is designed to integrate seamlessly with a variety of popular analysis tools, such as WALA, Tree-sitter, LLVM, and CodeQL, each implemented in different languages. Codellm-Devkit acts as a crucial intermediary layer, enabling efficient and consistent communication between these tools and the CodeLLMs.
3736

38-
Codellm-devkit is constantly evolving to include new tools and frameworks, ensuring it remains a versatile solution for code analysis and LLM integration.
37+
Codellm-Devkit is constantly evolving to include new tools and frameworks, ensuring it remains a versatile solution for code analysis and LLM integration.
3938

40-
Codellm-devkit is:
39+
Codellm-Devkit is:
4140

4241
- **Unified**: Provides a single framework for integrating multiple analysis tools and CodeLLMs, regardless of the programming languages involved.
4342
- **Extensible**: Designed to support new analysis tools and LLM platforms, making it adaptable to the evolving landscape of code analysis.
4443
- **Streamlined**: Simplifies the process of transforming raw code into structured, LLM-ready inputs, reducing the overhead typically associated with multi-language analysis.
4544

46-
Codellm-devkit is an ongoing project, developed at IBM Research.
45+
Codellm-Devkit is an ongoing project, developed at IBM Research.
4746

4847
## Contact
4948

‎docs/assets/css/theme.css‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ figcaption {
5858
overflow-y: hidden;
5959
}
6060

61-
/* Apply Kolena branding colors on top of 'default' scheme */
61+
/* Apply IBM branding colors on top of 'default' scheme */
6262
[data-md-color-scheme="default"] {
6363
--md-primary-fg-color: #0F62FE;
6464
--md-primary-fg-color--dark: #452485;
65-
--md-primary-fg-color--light: #835dcd;
65+
--md-primary-fg-color--light: #d4e3ff;
6666

6767
--md-typeset-a-color: #0F62FE; /* manually set link color to indigo */
6868

@@ -74,18 +74,17 @@ figcaption {
7474
--md-mg-insertion-color: #3e57d3;
7575
}
7676

77-
/* Apply Kolena branding on top of 'slate' (dark) scheme */
77+
/* Apply IBM branding on top of 'slate' (dark) scheme */
7878
@media screen {
7979
[data-md-color-scheme="slate"] {
8080
--md-primary-fg-color: #0F62FE;
8181
--md-primary-fg-color--dark: #332362;
8282
--md-primary-fg-color--light: #835dcd;
8383

84-
--md-typeset-a-color: #5F72FF; /* manually set link color to indigo */
84+
--md-typeset-a-color: #5f72ff; /* manually set link color to indigo */
8585

8686
--md-hue: 216;
8787

88-
/* crank down the saturation of these default colors -- less purplish than simply overriding --md-hue */
8988
--md-default-fg-color: hsla(var(--md-hue), 25%, 95%, 1);
9089
--md-default-fg-color--light: hsla(var(--md-hue), 25%, 90%, 0.62);
9190
--md-default-fg-color--lighter: hsla(var(--md-hue), 25%, 90%, 0.32);
@@ -115,7 +114,33 @@ figcaption {
115114
/* custom admonition type for FAQ */
116115
:root {
117116
--md-admonition-icon--faq: url('data:image/svg+xml;charset=utf-8,<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 16 16" enable-background="new 0 0 16 16" xml:space="preserve"><g id="flag_1_"><path fill-rule="evenodd" clip-rule="evenodd" d="M2.99,2.99c-0.55,0-1,0.45-1,1v11c0,0.55,0.45,1,1,1s1-0.45,1-1v-11C3.99,3.44,3.54,2.99,2.99,2.99z M2.99-0.01c-0.55,0-1,0.45-1,1s0.45,1,1,1s1-0.45,1-1S3.54-0.01,2.99-0.01z M4.99,3.02v7.23c2.07-2.11,5.92,1.75,9,0V3.02C10.99,5.09,7.05,0.99,4.99,3.02z"/></g></svg>');
117+
--md-tip-border-color: #0F62FE;
118+
--md-tip-bg-color: #0F62FE;
119+
--md-tip-text-color: #edf3ff;
118120
}
121+
122+
[data-md-color-scheme="dark"] {
123+
--md-tip-text-color: var(--md-default-fg-color--lighter);
124+
}
125+
126+
.md-typeset .admonition.tip,
127+
.md-typeset details.tip {
128+
border-color: var(--md-tip-border-color);
129+
}
130+
131+
.md-typeset .tip > .admonition-title,
132+
.md-typeset .tip > summary {
133+
background-color: var(--md-tip-bg-color);
134+
color: var(--md-tip-text-color);
135+
}
136+
137+
.md-typeset .tip > .admonition-title::before,
138+
.md-typeset .tip > summary::before {
139+
background-color: #edf3ff;
140+
-webkit-mask-image: var(--md-admonition-icon--tip);
141+
mask-image: var(--md-admonition-icon--tip);
142+
}
143+
119144
.md-typeset .admonition.faq,
120145
.md-typeset details.faq {
121146
border-color: var(--md-typeset-table-color);

‎docs/core-concepts/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "Core Concepts"
3+
icon: cldk/area-of-interest-20
4+
hide:
5+
- toc
6+
---
7+
8+
To be updated.

‎docs/index.md‎

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,35 @@ hide:
99

1010
<p align='center'>
1111
<a href="https://arxiv.org/abs/2410.13007">
12-
<img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=flat-square" />
12+
<img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=for-the-badge" />
1313
</a>
1414
<a href="https://www.python.org/downloads/release/python-3110/">
15-
<img src="https://img.shields.io/badge/python-3.11-blue?style=flat-square" />
15+
<img src="https://img.shields.io/badge/python-3.11-blue?style=for-the-badge" />
1616
</a>
1717
<a href="https://opensource.org/licenses/Apache-2.0">
18-
<img src="https://img.shields.io/badge/License-Apache%202.0-green?style=flat-square" />
18+
<img src="https://img.shields.io/badge/License-Apache%202.0-green?style=for-the-badge" />
1919
</a>
2020
<a href="https://ibm.github.io/codellm-devkit/">
21-
<img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=flat-square" />
21+
<img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=for-the-badge" />
2222
</a>
2323
<a href="https://badge.fury.io/py/cldk">
24-
<img src="https://img.shields.io/pypi/v/cldk?style=flat-square&label=codellm-devkit&color=blue" />
24+
<img src="https://img.shields.io/pypi/v/cldk?style=for-the-badge&label=codellm-devkit&color=blue" />
2525
</a>
2626
<a href="https://discord.gg/zEjz9YrmqN">
27-
<img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=flat-square"/>
27+
<img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=for-the-badge"/>
2828
</a>
2929
</p>
3030
---
3131

32-
[Codellm-devkit](https://cldk.info) (aka. CLDK) is a multilingual program analysis framework that bridges the gap between traditional static analysis tools and Large Language Models (LLMs) specialized for code (CodeLLMs). CLDK simplifies multi-language code analysis by providing a unified Python library that integrates outputs from various analysis tools and prepares them for effective use by CodeLLMs.
32+
[Codellm-Devkit](https://cldk.info) (aka. CLDK) is a multilingual program analysis framework that bridges the gap between traditional static analysis tools and Large Language Models (LLMs) specialized for code (CodeLLMs). CLDK simplifies multi-language code analysis by providing a unified Python library that integrates outputs from various analysis tools and prepares them for effective use by CodeLLMs.
3333

3434
CLDK streamlines the process of transforming raw code into actionable insights, enabling robust analysis pipelines and seamless integration with tools like WALA, Tree-sitter, LLVM, and CodeQL.
3535

3636
---
3737

3838
# :cldk-layers-20: Developer Guide
3939

40-
Learn how to use Codellm-devkit to analyze your code effectively:
40+
Get started with Codellm-Devkit:
4141

4242
<div class="grid cards" markdown>
4343

@@ -68,13 +68,57 @@ Learn how to use Codellm-devkit to analyze your code effectively:
6868
</div>
6969
---
7070

71-
## Why Codellm-devkit?
71+
---
72+
73+
# :cldk-learning-20: Use Cases
74+
75+
Learn how to leverage CLDK for various code analysis tasks:
76+
77+
<div class="grid cards" markdown>
78+
79+
- [:cldk-test-suite-16: Java Unit Test Generation](usecases/java/unit_test.md)
80+
81+
---
82+
83+
Understand how to use CLDK to generate unit tests for Java projects.
84+
85+
- [:cldk-text-summarization-16: Summarize Python Projects](usecases/python/explain.md)
86+
87+
---
88+
89+
Learn how to summarize Python projects using CLDK.
90+
91+
</div>
92+
---
93+
94+
# :cldk-rocket-20: Advanced Topics
95+
96+
Dive deeper into advanced topics
97+
98+
<div class="grid cards" markdown>
99+
100+
- [:cldk-rocket-16: Extending CLDK](advanced/extending.md)
101+
102+
---
103+
104+
Learn how to extend CLDK to a new language.
105+
106+
- [:cldk-workflow-16: Adding a New Analysis Backend](advanced/adding_backend.md)
107+
108+
---
109+
110+
Learn how to add a new analysis backend to CLDK.
111+
112+
</div>
113+
---
114+
115+
## Why Codellm-Devkit?
72116

73117
!!! tip inline "TL;DR"
74118

75119
CLDK unifies traditional program analysis tools with CodeLLMs, streamlining multi-language code analysis into a single, cohesive framework.
76120

77-
Current code analysis often involves juggling multiple disjointed tools and workflows. With Codellm-devkit, you can:
121+
Current code analysis often involves juggling multiple disjointed tools and workflows. With Codellm-Devkit, you can:
78122

79123
- **Unified**: Integrate various analysis tools and CodeLLMs into one cohesive framework.
80124
- **Extensible**: Easily add support for new tools and evolving LLM platforms.

0 commit comments

Comments
 (0)