Skip to content

Add architecture diagram#1278

Open
anushkagupta200615-jpg wants to merge 2 commits into
CodeGraphContext:mainfrom
anushkagupta200615-jpg:add-architecture-diagram
Open

Add architecture diagram#1278
anushkagupta200615-jpg wants to merge 2 commits into
CodeGraphContext:mainfrom
anushkagupta200615-jpg:add-architecture-diagram

Conversation

@anushkagupta200615-jpg

Copy link
Copy Markdown

📌 Description

This PR addresses issue #1253 by adding a Mermaid architecture diagram to the README.md to visually explain the CodeGraphContext workflow.

🚀 Changes Made

  • Added an Architecture & Workflow section just before the "Supported Programming Languages" section.
  • Implemented a beautifully styled Mermaid flowchart that clearly illustrates the data flow: from Source Code Parsing via Tree-sitter/SCIP, to Knowledge Graph generation, Database storage, and finally querying through the CLI Toolkit and MCP Server for AI Assistants.
  • Applied custom CSS classes (classDef) within the Mermaid diagram to give it a modern dark-mode aesthetic (purple/blue accents) that matches the project's branding.

✅ Expected Outcome

  • New users can now quickly understand how the different components of CodeGraphContext interact at a glance.
  • Reduces the cognitive load required to understand the system architecture compared to reading multiple text sections.

Resolves #1253

@vercel

vercel Bot commented Jun 17, 2026

Copy link
Copy Markdown

@anushkagupta200615-jpg is attempting to deploy a commit to the shashankss1205's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog tasks

Development

Successfully merging this pull request may close these issues.

README: Add Mermaid architecture diagram explaining CGC workflow

1 participant