DocUbot — Documentation Generator Agent

DocUbot is a VS Code extension that automatically generates complete technical documentation for your project using GitHub Copilot. It scans your repository, analyzes the code structure, and produces professional Markdown documentation, which can be saved locally and pushed to a Confluence page via the internal Doc-AI API.

Features

• @doc chat participant — trigger documentation generation directly from the GitHub Copilot Chat panel
• Project scanning — automatically reads your repository structure and key source files
• AI-powered documentation — generates a full Markdown document including architecture, modules, technologies, endpoints, and usage
• Local file output — documentation is saved to docs/documentation.md in your workspace (can be disabled)
• Confluence integration — saves the generated documentation to a configurable Confluence path via the Doc-AI API
• Okta authentication — secure API calls using PKCE OAuth 2.0 flow with Okta

Requirements

• VS Code ^1.90.0
• GitHub Copilot extension installed and active
• An active Okta session (see the Okta Setup section below)

Okta Setup

Before using @doc, you must configure and authenticate with Okta. The extension uses the PKCE OAuth 2.0 flow to obtain a secure access token.

1. Configure Okta

Run the command Okta: Configure from the Command Palette (Ctrl+Shift+P).

You will be prompted to fill in the following values:

These values can also be set directly in your VS Code workspace settings under the oktaAuth.* namespace.

2. Log in to Okta

Run the command Okta: Login from the Command Palette (Ctrl+Shift+P).

This will:

1. Open a browser tab pointing to the Okta authorization page.
2. After you authenticate in the browser, Okta redirects back to http://127.0.0.1:<port><redirectPath>.
3. The extension exchanges the authorization code for an access token and stores it securely in VS Code's secret storage.
4. A confirmation message "Connection successful!" is shown.

Automatic prompt — if you type @doc in the Copilot Chat panel without an active session, the login flow is automatically triggered before any documentation is generated.

3. Verify / Logout

• Check current session — a session is active as long as the stored access token has not expired. Token expiry is checked automatically at each @doc invocation.
• Log out — run the command Okta: Logout to delete the stored session and force a new login on the next use.

Troubleshooting

Using @doc

1. Open the GitHub Copilot Chat panel (Ctrl+Alt+I).
2. Type @doc followed by any optional instruction (or just press Enter).
3. If no Okta session is active, the login flow starts automatically.
4. The extension scans your repository, generates documentation with Copilot, and streams the result directly in the chat.
5. Once generation is complete:
   • The documentation is saved locally to docs/documentation.md at the root of your workspace (enabled by default, see below).
   • It is also pushed to Confluence via the Doc-AI API using the configured project URL and Confluence path.

Local Documentation File

At the start of each @doc generation, you will be asked:

Save documentation locally?

• Yes — write the documentation to docs/documentation.md at the root of your workspace (default)
• No — only push to Confluence, no local file is created

The local file is created (or overwritten) on each generation when you choose Yes.

All Available Settings

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference