CodeDoc

FrontEnd

Inspiration

When our team came to ShellHacks, we all agreed to approach and commit to the Google Challenge of ADK. We were interested in this specific challenge because it's a new tool that incorporates aspects of AI. For the direction we wanted our project to take, we all asked ourselves: "What's something all developers struggle with?" We all agreed that, in Agile workflows, a lack of documentation results in a lack of communication and wasted company resources. It's difficult to constantly write documentation in an Agile workflow, especially when things updates frequently. Our project CodeDoc was created to solve that specific issue by automating Documentation and merging issues.

What it does

CodeDoc actively works using Google ADK. With the use of the Agent2Agent protocol, we can use multiple agents for one cause. These agents will specifically read .java and .py files and generate documentation that details each function or method, along with the variable types used. After each documentation check, CodeDoc allows you to upload two documents to check for potential merging issues. This will allow teams or companies to safely push the same task files with no merging errors.

How we built it

We built CodeDoc on documentation and free videos on YouTube. We used the open-source documentation, which provided the tools and methods that ADK was built on. It also included the specific behaviors of each agent and the protocols they followed. Not only did we build it with ADK, but we also used Streamlit and ADK API servers. This setup allowed us to connect to an API with our ADK and access its endpoints. Streamlit was used for the front-end, sending HTTP requests to the API's endpoints.

Challenges we ran into

The challenges we ran into are based on these two factors: ADK is a relatively new tool, and most of our team has not worked with any type of development in AI. As a result, we needed to do a lot of research on how to use Google ADK. Sometimes we were using tools we had never seen before, but we used resources to understand them.

Accomplishments that we're proud of

As a team, we are happy that our project reflected the goals we wanted to have at submission. Our main accomplishment is that even though the majority of the time we were very confused about ADK, we were able to figure out how to understand and use it.

What we learned

We learned to not give up on specific tasks even though they looked very difficult. This helped us persevere in the sense that there is a solution for everything.

What's next for CodeDoc

After ShellHacks, we plan to continue developing CodeDoc by implementing a feature that continuously checks documentation as Github repositories get updated. This allows us to only do a one-time check-in on CodeDoc to set it up and turn it off when you want.