DevSync

Inspiration

When a new developer joins a project, understanding its purpose, logic, and structure requires manually navigating through files, documentation (if available), and commit histories. Traditional GitHub repositories lack an intuitive way to link project requirements (as per SRS) with actual code. This results in time consuming onboarding, difficulty in tracking features, and unstructured documentation. A platform that automates project understanding by mapping SRS to code, providing guided onboarding, and offering interactive documentation is essential.

What it does

DevSync is a Visual Studio Code extension designed to automate project understanding by mapping Software Requirement Specifications (SRS) to code, providing interactive documentation, and assisting developers with guided onboarding. This extension enhances the development experience by offering intelligent project navigation, AI-powered search, and real-time documentation updates.

How we built it

Core Development
Language: TypeScript (for VS Code extension development)
Framework: Node.js (for backend services)
VS Code API: To interact with the editor and provide UI elements
GitHub Integration
GitHub REST API: Fetch repositories, commits, and pull requests
GitHub GraphQL API: Query structured repository data efficiently
SRS-to-Code Mapping & Search
LangChain.js / OpenAI API: AI-powered code understanding and feature mapping
AST Parsing (Abstract Syntax Trees): To analyze code structure and match SRS requirements
Interactive Documentation
Markdown & Docusaurus: Generate and manage documentation dynamically
VS Code Webview API: Display interactive documentation inside VS Code
Dependency & Architecture Visualization
Graphviz / D3.js: For visualizing project structure and dependencies
AST-based Analysis: To map function and module interactions

Challenges we ran into

Initially, we considered developing a web-based solution. However, after evaluating the challenges developers face while navigating repositories, we decided to build a VS Code extension for a more seamless and integrated experience. API key usage getting expired quickly, visualization errors

Accomplishments that we're proud of

📜 SRS-to-Code Mapping: Automatically link SRS requirements to relevant code sections. 🧭 Intelligent Navigation: Provide structured insights into project architecture. 📖 Interactive Documentation: Dynamically update documentation based on commits. 👨‍🏫 Guided Onboarding: Step-by-step breakdown of project components. 🔍 AI-powered Search: Contextual search to locate relevant code snippets. 🔗 GitHub Integration: Sync repositories for real-time tracking. 🎨 Dependency Visualization: Graphical representation of module interactions. By embedding these features directly within VS Code, we ensure developers can understand, explore, and contribute to projects efficiently without leaving their IDE.