Merge pull request #83 from codellm-devkit/docs

Revamp documentation page!

Author: rahlk

.github/workflows/mkdocs-deploy.yml

@@ -2,7 +2,8 @@ name: mkdocs-deploy
 on:
   push:
     branches:
-      - docs
+      - docs 
+      
 permissions:
   contents: write
 jobs:
@@ -19,6 +20,6 @@ jobs:
         with:
           python-version: "3.11"
       - name: Install Dependencies
-        run: pip install mkdocs-material mkdocs-autorefs mkdocs-get-deps mkdocs-material-extensions mkdocstrings mkdocstrings-python
+        run: pip install mkdocs-material[imaging] mkdocs-autorefs mkdocs-get-deps mkdocs-material-extensions mkdocstrings mkdocstrings-python mkdocs-git-revision-date-localized-plugin
       - name: Deploy docs
         run: mkdocs gh-deploy --force --verbose

.gitignore

@@ -14,6 +14,9 @@
 # BlueJ files
 *.ctxt
 
+# Cache files
+.cache/
+
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 

README.md

@@ -25,24 +25,24 @@
   </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
 
@@ -55,17 +55,16 @@ For any questions, feedback, or suggestions, please contact the authors:
 | Saurabh Sihna | [[email protected]](mailto:[email protected]) |
 ## Table of Contents
 
-- [CodeLLM-Devkit: A Python library for seamless interaction with CodeLLMs](#codellm-devkit-a-python-library-for-seamless-interaction-with-codellms)
-  - [Contact](#contact)
-  - [Table of Contents](#table-of-contents)
-  - [Architectural and Design Overview](#architectural-and-design-overview)
-  - [Quick Start: Example Walkthrough](#quick-start-example-walkthrough)
-    - [Prerequisites](#prerequisites)
-    - [Step 1:  Set up an Ollama server](#step-1--set-up-an-ollama-server)
-      - [Pull the latest version of Granite 8b instruct model from ollama](#pull-the-latest-version-of-granite-8b-instruct-model-from-ollama)
-    - [Step 2:  Install CLDK](#step-2--install-cldk)
-    - [Step 3:  Build a code summarization pipeline](#step-3--build-a-code-summarization-pipeline)
-    - [Publication (papers and blogs related to CLDK)](#publication-papers-and-blogs-related-to-cldk)
+- [Contact](#contact)
+- [Table of Contents](#table-of-contents)
+- [Architectural and Design Overview](#architectural-and-design-overview)
+- [Quick Start: Example Walkthrough](#quick-start-example-walkthrough)
+  - [Prerequisites](#prerequisites)
+  - [Step 1:  Set up an Ollama server](#step-1--set-up-an-ollama-server)
+    - [Pull the latest version of Granite 8b instruct model from ollama](#pull-the-latest-version-of-granite-8b-instruct-model-from-ollama)
+  - [Step 2:  Install CLDK](#step-2--install-cldk)
+  - [Step 3:  Build a code summarization pipeline](#step-3--build-a-code-summarization-pipeline)
+  - [Publication (papers and blogs related to CLDK)](#publication-papers-and-blogs-related-to-cldk)
 
 ## Architectural and Design Overview
 

docs/CNAME

@@ -0,0 +1 @@
+codellm-devkit.info