-
-
Homepage
Inspiration
The project was born from the repetitive frustration of manually documenting complex codebases. We realized that developers often neglect READMEs due to the significant time required for drafting. By leveraging AI, we aimed to turn this multi-hour chore into a seamless, automated experience.
What it does
Nolthren performs a deep analysis of your GitHub repository's code, structure, and dependencies. It utilizes Gemini AI to generate professional, context-aware README sections and tech badges. Users can then customize, reorder, and live-preview their documentation before exporting it.
How we built it
The application is built using a modern React stack and styled with responsive Tailwind CSS. We integrated the GitHub REST and GraphQL APIs to securely fetch repository data and metadata. Google's Gemini API serves as the core engine for generating structured documentation from code.
Challenges we ran into
Orchestrating the GitHub API to fetch massive file trees without hitting rate limits was difficult. Selecting the most "important" code snippets to stay within AI token windows required fine-tuning. Ensuring the AI consistently returned valid, parseable JSON for a modular UI was a major hurdle.
Accomplishments that we're proud of
We successfully created a fully client-side tool that handles complex data processing without a backend. The "Regenerate Section" feature allows for surgical AI updates without losing other manual edits. Delivering a high-performance, accessible UI that makes technical documentation feel fast and fun.
What we learned
We mastered the use of Gemini’s responseSchema to guarantee structured data for our frontend. I discovered efficient ways to prioritize files for analysis based on language and size. We also learned the importance of "Bring Your Own Key" models for sustainable open-source tools.
What's next for Nolthren
We plan to implement support for private repositories using secure GitHub OAuth integration. Adding AI-powered image generation for project logos and social preview cards is on the roadmap.
Log in or sign up for Devpost to join the conversation.