Add CNAME to codellm-devkit.info

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>

Author: rahlk

.github/workflows/mkdocs-deploy.yml

@@ -3,7 +3,6 @@ on:
   push:
     branches:
       - docs 
-      - main
 
 permissions:
   contents: write

README.md

@@ -1,4 +1,3 @@
-<!-- # CodeLLM-Devkit: A Python library for seamless interaction with CodeLLMs -->
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="docs/assets/images/cldk-dark.png">
   <source media="(prefers-color-scheme: light)" srcset="docs/assets/images/cldk-light.png">
@@ -7,43 +6,43 @@
 
 <p align='center'>
   <a href="https://arxiv.org/abs/2410.13007">
-    <img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=flat-square" />
+    <img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=for-the-badge" />
   </a>
   <a href="https://www.python.org/downloads/release/python-3110/">
-    <img src="https://img.shields.io/badge/python-3.11-blue?style=flat-square" />
+    <img src="https://img.shields.io/badge/python-3.11-blue?style=for-the-badge" />
   </a>
   <a href="https://opensource.org/licenses/Apache-2.0">
-    <img src="https://img.shields.io/badge/License-Apache%202.0-green?style=flat-square" />
+    <img src="https://img.shields.io/badge/License-Apache%202.0-green?style=for-the-badge" />
   </a>
   <a href="https://ibm.github.io/codellm-devkit/">
-    <img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=flat-square" />
+    <img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=for-the-badge" />
   </a>
   <a href="https://badge.fury.io/py/cldk">
-    <img src="https://img.shields.io/pypi/v/cldk?style=flat-square&label=codellm-devkit&color=blue" />
+    <img src="https://img.shields.io/pypi/v/cldk?style=for-the-badge&label=codellm-devkit&color=blue" />
   </a>
   <a href="https://discord.gg/zEjz9YrmqN">
-    <img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=flat-square"/>
+    <img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=for-the-badge"/>
   </a>
 </p>
 
-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.
+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.
 
-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.
+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.
 
-**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.**
-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.
+**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.**
+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.
 
-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.
+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.
 
-Codellm-devkit is constantly evolving to include new tools and frameworks, ensuring it remains a versatile solution for code analysis and LLM integration.
+Codellm-Devkit is constantly evolving to include new tools and frameworks, ensuring it remains a versatile solution for code analysis and LLM integration.
 
-Codellm-devkit is:
+Codellm-Devkit is:
 
 - **Unified**: Provides a single framework for integrating multiple analysis tools and CodeLLMs, regardless of the programming languages involved.
 - **Extensible**: Designed to support new analysis tools and LLM platforms, making it adaptable to the evolving landscape of code analysis.
 - **Streamlined**: Simplifies the process of transforming raw code into structured, LLM-ready inputs, reducing the overhead typically associated with multi-language analysis.
 
-Codellm-devkit is an ongoing project, developed at IBM Research.
+Codellm-Devkit is an ongoing project, developed at IBM Research.
 
 ## Contact
 

docs/assets/css/theme.css

@@ -58,11 +58,11 @@ figcaption {
   overflow-y: hidden;
 }
 
-/* Apply Kolena branding colors on top of 'default' scheme */
+/* Apply IBM branding colors on top of 'default' scheme */
 [data-md-color-scheme="default"] {
   --md-primary-fg-color: #0F62FE;
   --md-primary-fg-color--dark: #452485;
-  --md-primary-fg-color--light: #835dcd;
+  --md-primary-fg-color--light: #d4e3ff;
 
   --md-typeset-a-color: #0F62FE; /* manually set link color to indigo */
 
@@ -74,18 +74,17 @@ figcaption {
   --md-mg-insertion-color: #3e57d3;
 }
 
-/* Apply Kolena branding on top of 'slate' (dark) scheme */
+/* Apply IBM branding on top of 'slate' (dark) scheme */
 @media screen {
   [data-md-color-scheme="slate"] {
     --md-primary-fg-color: #0F62FE;
     --md-primary-fg-color--dark: #332362;
     --md-primary-fg-color--light: #835dcd;
 
-    --md-typeset-a-color:              #5F72FF; /* manually set link color to indigo */
+    --md-typeset-a-color:              #5f72ff; /* manually set link color to indigo */
 
     --md-hue: 216;
 
-    /* crank down the saturation of these default colors -- less purplish than simply overriding --md-hue */
     --md-default-fg-color:             hsla(var(--md-hue), 25%, 95%, 1);
     --md-default-fg-color--light:      hsla(var(--md-hue), 25%, 90%, 0.62);
     --md-default-fg-color--lighter:    hsla(var(--md-hue), 25%, 90%, 0.32);
@@ -115,7 +114,33 @@ figcaption {
 /* custom admonition type for FAQ */
 :root {
   --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>');
+  --md-tip-border-color: #0F62FE;
+  --md-tip-bg-color: #0F62FE;
+  --md-tip-text-color: #edf3ff;
 }
+
+[data-md-color-scheme="dark"] {
+  --md-tip-text-color: var(--md-default-fg-color--lighter);
+}
+
+.md-typeset .admonition.tip,
+.md-typeset details.tip {
+  border-color: var(--md-tip-border-color);
+}
+
+.md-typeset .tip > .admonition-title,
+.md-typeset .tip > summary {
+  background-color: var(--md-tip-bg-color);
+  color: var(--md-tip-text-color);
+}
+
+.md-typeset .tip > .admonition-title::before,
+.md-typeset .tip > summary::before {
+  background-color: #edf3ff;
+  -webkit-mask-image: var(--md-admonition-icon--tip);
+          mask-image: var(--md-admonition-icon--tip);
+}
+
 .md-typeset .admonition.faq,
 .md-typeset details.faq {
   border-color: var(--md-typeset-table-color);

docs/core-concepts/index.md

@@ -0,0 +1,8 @@
+---
+title: "Core Concepts"
+icon: cldk/area-of-interest-20
+hide:
+  - toc
+---
+
+To be updated.

docs/index.md

@@ -9,35 +9,35 @@ hide:
 
 <p align='center'>
   <a href="https://arxiv.org/abs/2410.13007">
-    <img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=flat-square" />
+    <img src="https://img.shields.io/badge/arXiv-2410.13007-b31b1b?style=for-the-badge" />
   </a>
   <a href="https://www.python.org/downloads/release/python-3110/">
-    <img src="https://img.shields.io/badge/python-3.11-blue?style=flat-square" />
+    <img src="https://img.shields.io/badge/python-3.11-blue?style=for-the-badge" />
   </a>
   <a href="https://opensource.org/licenses/Apache-2.0">
-    <img src="https://img.shields.io/badge/License-Apache%202.0-green?style=flat-square" />
+    <img src="https://img.shields.io/badge/License-Apache%202.0-green?style=for-the-badge" />
   </a>
   <a href="https://ibm.github.io/codellm-devkit/">
-    <img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=flat-square" />
+    <img src="https://img.shields.io/badge/GitHub%20Pages-Docs-blue?style=for-the-badge" />
   </a>
   <a href="https://badge.fury.io/py/cldk">
-    <img src="https://img.shields.io/pypi/v/cldk?style=flat-square&label=codellm-devkit&color=blue" />
+    <img src="https://img.shields.io/pypi/v/cldk?style=for-the-badge&label=codellm-devkit&color=blue" />
   </a>
   <a href="https://discord.gg/zEjz9YrmqN">
-    <img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=flat-square"/>
+    <img src="https://dcbadge.limes.pink/api/server/https://discord.gg/zEjz9YrmqN?style=for-the-badge"/>
   </a>
 </p>
 ---
 
-[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.
+[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.
 
 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.
 
 ---
 
 # :cldk-layers-20: Developer Guide
 
-Learn how to use Codellm-devkit to analyze your code effectively:
+Get started with Codellm-Devkit:
 
 <div class="grid cards" markdown>
 
@@ -68,13 +68,57 @@ Learn how to use Codellm-devkit to analyze your code effectively:
 </div>
 ---
 
-## Why Codellm-devkit?
+---
+
+# :cldk-learning-20: Use Cases
+
+Learn how to leverage CLDK for various code analysis tasks:
+
+<div class="grid cards" markdown>
+
+- [:cldk-test-suite-16: Java Unit Test Generation](usecases/java/unit_test.md)
+
+    ---
+
+    Understand how to use CLDK to generate unit tests for Java projects.
+
+- [:cldk-text-summarization-16: Summarize Python Projects](usecases/python/explain.md)
+
+    ---
+
+    Learn how to summarize Python projects using CLDK.
+
+</div>
+---
+
+# :cldk-rocket-20: Advanced Topics
+
+Dive deeper into advanced topics
+
+<div class="grid cards" markdown>
+
+- [:cldk-rocket-16: Extending CLDK](advanced/extending.md)
+
+    ---
+
+    Learn how to extend CLDK to a new language.
+
+- [:cldk-workflow-16: Adding a New Analysis Backend](advanced/adding_backend.md)
+  
+    ---
+
+    Learn how to add a new analysis backend to CLDK.
+
+</div>
+---
+
+## Why Codellm-Devkit?
 
 !!! tip inline "TL;DR"
 
     CLDK unifies traditional program analysis tools with CodeLLMs, streamlining multi-language code analysis into a single, cohesive framework.
 
-Current code analysis often involves juggling multiple disjointed tools and workflows. With Codellm-devkit, you can:
+Current code analysis often involves juggling multiple disjointed tools and workflows. With Codellm-Devkit, you can:
 
 - **Unified**: Integrate various analysis tools and CodeLLMs into one cohesive framework.
 - **Extensible**: Easily add support for new tools and evolving LLM platforms.