Polybot Documentation

Discover the power of automated documentation with the Polybot GitHub App integration for Visual Studio Code! This extension enables you to quickly search and navigate through automatically generated documentation within your codebase. Stay up-to-date and enhance your development experience with seamless access to relevant documentation right in your editor, ensuring that you always have the most recent information available after each push to your GitHub repository.

Features

• Quickly search for documentation using the search bar in the status bar or by selecting a text in the code editor.
• Access the Polybot GitHub App installation page via the command palette.
• Preview search results in a separate webview panel within Visual Studio Code.

Requirements

• Visual Studio Code version 1.77.0 or higher
• Polybot GitHub App installed in your GitHub organization

Extension Settings

• polybot.accessToken: Access token for Polyfact docs

Getting Started

1. Install the Polybot extension in Visual Studio Code.
2. Install the Polybot GitHub App in your GitHub organization by following this link.
3. Configure your polybot.accessToken in your Visual Studio Code settings.

Usage

Search using the search bar

1. Click on the "Polybot Docs" search bar located in the status bar.
2. Enter a keyword or term to search for related documentation.
3. The search results will be displayed in a new webview panel.

Search by selecting text

1. Select a text in the code editor.
2. Right-click and choose "Get docs with Polybot" from the context menu.
3. The search results will be displayed in a new webview panel.

Access the Polybot GitHub App installation page

1. Open the command palette (Cmd+Shift+P on Mac or Ctrl+Shift+P on Windows/Linux).
2. Type "Open Polybot GitHub App Installation Page" and press Enter.
3. The installation page will open in your default web browser.

Troubleshooting

• If you encounter an error stating that no workspace folder is opened, please make sure to open a folder in your Visual Studio Code workspace.
• If you receive a warning about needing to install the Polybot GitHub App, please follow the provided link to install it in your GitHub organization.

Contributing

If you have any questions, suggestions, or want to contribute to the Polybot extension, please visit the Polybot GitHub repository.

Release Notes

0.1.1

• Initial release of Polybot extension for Visual Studio Code.