Hover: In‑Context Code Documentation for Any Webpage

Hover is a lightweight browser extension that allows users to hover over any code snippet on a webpage and instantly view its documentation, just as they would in a modern IDE. Designed for developers who frequently traverse documentation sites, read code in AI chat applications like ChatGPT and Claude, or simply want contextual help while browsing, Hover delivers real‑time insights without leaving the page. ## Core Features - **Universal Coverage**: Works on any website that contains code blocks, from static documentation portals to live chat interfaces. - **IDE‑like Experience**: Hovering over a symbol or function name triggers a tooltip that displays importable documentation. - **Extensible Back‑end**: By default it ships with support for the OpenRouter API, but users may also plug in any custom endpoint that follows the OpenAI protocol. - **Fine‑tuned Access Control**: You can restrict the extension to specific domains via URL patterns (for example, `*://*.github.com/*`) to keep sensitive projects private. ## Getting Started All installation steps assume a local development environment; the Chrome Web Store version will be published shortly. 1. **Build the Extension** ```bash bun install && bun run build ``` 2. **Load Into Chrome** * Open `chrome://extensions`. * Toggle **Developer Mode**. * Click **Load Unpacked** and choose the `dist_chrome` folder. 3. **Configure an API Key** * Click the Hover icon in the toolbar. * Navigate to **Settings** and enter either an OpenRouter API key or the URL of a custom OpenAI‑compatible endpoint. 4. **Define Target Sites** * In Settings, specify URL patterns such as `*://*.github.com/*` to control where the tooltip functionality is active. ## Development Workflow Hover uses Bun for a fast JavaScript/TypeScript toolchain: | Command | Description | |---------|-------------| | `bun run dev` | Starts a hot‑reload dev server for rapid iteration. | | `bun run build` | Generates a production build and performs linting. | | `bun run lint` | Runs ESLint to enforce code quality. | | `bun run format` | Formats code with Prettier. | | `bun run package` | Bundles the extension into a `hover-extension.zip` suitable for the Chrome Web Store. | *Optional:* Place a `.env` file in the root with `VITE_OPEN_ROUTER_API_KEY=your‑key` to embed an API key into development builds. ## Testing and Evaluation Comprehensive tests and evaluation scripts are described in `scripts/README.md`. These cover unit tests, integration tests against mocked API responses, and end‑to‑end checks that simulate user interaction. ## Known Issues & Roadmap All current bugs and planned feature enhancements are tracked in `TASKS.md`. Contributors are encouraged to review the repo’s issue tracker and participate in discussions. ## Privacy Policy Hover's data handling practices are detailed in `PRIVACY.md`. The extension only forwards the text of hovered code snippets to the configured API; no other user data is transmitted. Users retain full control over which endpoints are contacted. ## Licensing Hover is released under the MIT license, allowing free commercial and non‑commercial use, modification, and distribution. --- With Hover, developers can effortlessly access documentation on the fly, increasing productivity across a wide range of web‑based coding environments. Its open‑source nature, combined with clear documentation and a straightforward build system, makes it an attractive addition to any developer’s toolkit.