Nebula: AI tool that analyzes GitHub repos to auto-generate documentation. Extracts code structure, creates README files, and identifies tech stacks using Gemini, GROQ LLM. Uses MongoDB vector search.
Nebula is an AI-powered documentation generation tool that automatically transforms complex code repositories into professional documentation. By analyzing GitHub repositories, Nebula creates comprehensive documentation in various formats, saving developers significant time and effort.
Core Functionality
Analyzes GitHub repositories using AI to understand code structure and extract insights
Automatically generates professional READMEs, technical articles, and social media content
Organizes documentation by type and purpose with section-based editing features
Provides preview mode to see rendered markdown during editing
Technical Implementation
The project uses a modern tech stack with:
Frontend: Next.js, React, TailwindCSS
Backend: Node.js, Express
Database: MongoDB
Authentication: Clerk
Deployment: Vercel (frontend), Railway (backend)
Web3 Integration
Nebula incorporates blockchain technology through its Nebula-Dapp component, which enables:
Publishing user-generated documentation articles to the blockchain
Smart contract integration via Solidity (in the Nebula-contracts repository)
Web3 framework implementation through the third-web framework
Decentralized storage of documentation, likely providing ownership verification and permanence
The project consists of multiple repositories that work together:
Main Nebula repository (frontend)
Nebula-backend (API and processing)
Nebula-contracts (Solidity smart contracts)
Nebula-dapp (decentralized application interface)
This architecture allows users to not only generate documentation automatically but also publish and own their technical content on the blockchain through the dapp component.
1. Project Ideation, architecture/workflow designed & Project initialized. 2. Landing Page added. 3. Authentication Page. 4. set up LLM Responses. 5. Authentication (Clerk) 6. Pages added. 7. models, prompts (backend) 8. Utils, database operations. 9. Pages added (UI). 10. Formats added. 11. Integrations of frontend and backend. 12. Some Bug fixes. 13. More routes added. 14. Web3 integrated.