ReadDocs is a browser extension which reads the code documentations for you, so you can find necessary information faster and get code snippets instantly.
I am building this in public at https://twitter.com/abrarfairuj
ReadDocs is pretty straightforward. It's a simple interface which you can pull up from top and ask any question immediately about the currently opened documentation page.
You can download the published version from Chrome web store: https://chromewebstore.google.com/detail/read-docs/bohbadhodpeobkhnfcldoiofdgmfilej
To try from the repository, go through the following steps:
- Clone the repository:
git clone https://github.com/madcoderme/readdocs.git - Navigate to Chrome Extensions: Open Chrome and go to
chrome://extensions. - Enable Developer Mode: Toggle the switch in the top right corner.
- Load unpacked extension: Click on "Load unpacked" and select the directory where you cloned the repository.
- Obtain an API Key: You'll need a valid API key for Google Generative AI. You can obtain one by following the instructions here.
- Enter API Key: Once installed, the extension will prompt you to enter your API key.
- Provide Documentation: Navigate to the documentation page you want to use.
- Start Chatting: Ask your questions in the prompt window and receive answers from the AI model.
- The extension uses the
google-generative-ai.jsscript to interact with the Generative AI API. - The
gemini-promodel is used for its ability to understand and respond to technical documentation. - The
markedandhighlight.jslibraries are used for formatting and syntax highlighting of the responses.
Contributions are welcome! Please feel free to submit pull requests for bug fixes, improvements, or new features.
ReadDocs is a free tool beside SupaCodes. Supacodes can automatically generate & update internal code documentations right in Github. If you are working in teams, ditch the docs hassle with Supacodes and ReadDocs. ReadDocs uses Supacodes to document its source files.