AutoDocs-AI

Inspiration

Our inspiration for AutoDocs-AI came from a shared frustration among developers: the time-consuming, often neglected task of documentation. We envisioned a seamless integration of innovative AI technology with Atlassian Forge, creating a solution that automates documentation generation based on code commits. The goal was to not only improve documentation quality but also to make the dream of DocOps a reality.

What it does

AutoDocs-AI is a tool that leverages the power of ChatGPT, GitHub API, React, TypeScript, and the Atlassian Forge platform. It automatically generates comprehensive documentation from code repositories, eliminating the need for manual documentation. When a developer commits code, AutoDocs-AI intelligently analyzes the changes and creates corresponding documentation. This simplifies the development process and ensures that code and documentation stay in sync.

How we built it

Building AutoDocs-AI was an exciting yet challenging journey. We integrated multiple technologies, including ChatGPT, the GitHub API, React, TypeScript, and Atlassian Forge. By combining these tools, we developed an efficient system for code-commit-based documentation generation. We designed an intuitive user interface using React, while TypeScript ensured code integrity. Integrating with Atlassian Forge provided the platform for seamless execution within the Atlassian ecosystem.

Challenges we ran into

Our journey wasn't without its hurdles. Adapting to the unique environment of Atlassian Forge presented a learning curve. Initially, we encountered challenges accessing repository details from the public API. Overcoming this hurdle required creative problem-solving and resourcefulness. Additionally, effectively integrating ChatGPT into the process was a complex task that we had to tackle.

Accomplishments that we're proud of

We're proud to have created a functional prototype of AutoDocs-AI. Our system demonstrates the feasibility of automated documentation generation on code commits, a groundbreaking achievement. We also managed to seamlessly integrate our solution into Atlassian Forge, opening the door for countless developers to improve their workflow. Our team's collaborative effort and dedication to the project were instrumental in our achievements.

What we learned

Through this project, we gained valuable insights into the potential of Atlassian Forge. We learned how to navigate its unique environment and tap into its powerful capabilities for developers. Additionally, we deepened our understanding of AI integration, particularly with ChatGPT, and its transformative impact on the software development process.

What's next for AutoDocs-AI

The journey of AutoDocs-AI is just beginning. Our next steps include refining and expanding the capabilities of our system. We aim to improve its accuracy in documenting complex code. We also plan to explore further integrations with Atlassian's suite of products, including Jira and Confluence. Ultimately, we want to bring AutoDocs-AI to developers worldwide, revolutionizing the way they create and maintain documentation, and make the dream of DocOps a universal reality.

Built With

• atlassian-confluence
• forge
• react
• typescript