ArchiText | Devpost

Inspiration

Have you ever written code that you really don't want to go back and document? Inherited a file that is a poorly maintained mess? ArchiText is here to help!

What it does

ArchiText provides users with the ability to generate function and class documentation with just the press of a button! The VS code extension supports multiple popular languages such as C, C++, Python, Rust, Java and more!

How we built it

We used VS Code's JavaScript extension builder to interface directly with the editor and detect language, functions and classes. When creating comments, the extension uses the Google Gemini AI api to analyze your code and create documentation!

Challenges we ran into

For most of us, this was our first exposure to many of the tools that we used to make this project work. We learned about async functions and commands in JS, inserting inline comments using CodeLens, formatting using Json, and how to interface with an api. Another challenge we faced was finding an appropriate LLM model to suit our needs. We experimented with several locally hosted and web based models to test for output formatting and general response time.

Accomplishments that we're proud of

We're very proud of the work we've created here at Spartahacks X. When working with so many new technologies, there's a very steep learning curve to climb. Regardless of the challenges, we were able to deliver a project that met all of the goals that we set out to achieve!

What's next for ArchiText

The next steps for ArchiText include expanding the extension to support in-line documentation for declared variables and operations, using HTML to make generated text available via website, and fine tuning the Gemini AI to provide more consistent feedback.