About The Project

I was getting very tired using the power of AI trough web frontends and wanted to get in touch with an AI API to automate one of the most tedious yet important tasks in software engineering: documentation.

This repository encompasses a VSCode plugin which allows to add documentation to code written in any programming language using Google's Gemini.

An API Key is required to use this plugin. You can get yourself a free key for the Gemini API here

(back to top)

Built With

(back to top)

Usage

Prerequisites

Make sure to provide your Gemini API key Settings > extensions > Gemini Scribe. You can get yourself a free Gemini API key here.

Calling Gemini

In order to add documentation to your code select the part you want to document and open the command palette. Then choose the command Gemini Scribe: Add Dcoumentation.

This will send an appropriate prompt to the Gemini API to make it document your selected code.

Local Development

Make sure Node.js and NPM are installed.

Install Dependencies

Install dependencies with NPM using

npm install

Start and Debug

When using VSCode you might just press F5 or Run > Start Debugging in the toolbar at the top in order to start the plugin development setup in debug mode. This will also open a sample VSCode window for you where you can test this plugin of any code you provide.

Roadmap

• [x] Add command to document existing code
• [ ] Add command to shorten code
• [ ] Add command to optimize time complexity
• [ ] Add command to write unit tests

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Acknowledgments

Thanks A LOT to othneildrew for this amazing README.md template!

(back to top)