Swimm for GitHub Copilot
Generate Documentation from Copilot Chat that Stays Up-to-Date Automatically
Swimm integrates with GitHub Copilot to effortlessly generate documentation from Copilot chats and keep it synchronized with your codebase. This approach ensures your documentation is always up-to-date, making it easier for developers to track changes as they happen.
Getting Started
Visit the official GitHub Marketplace page to install: Swimm for GitHub Copilot
| Prerequisite | Description |
|---|---|
| GitHub Copilot Subscription | Active subscription on your GitHub Org |
| Admin Privileges | Required to install GitHub apps |
Overview
Auto-Generate Documentation
Use GitHub Copilot to generate Swimm documentation as you develop code. Convert Copilot chat into a document, assign it to relevant areas in your workspace, and manage updates automatically.
Improve Copilot
The more documentation you create, the better Copilot becomes at providing expert-level outputs similar to your top engineers.
Documentation Syncing
s the codebase evolves, Swimm detects changes and updates the documentation accordingly to ensure accuracy.
How It Works
1. Ask GitHub Copilot a question
- In your codebase, ask Copilot a relevant question (e.g., "What testing frameworks do we use?").
2. Copilot provides a response
- Copilot identifies relevant information in your project and provides an answer.
3. Generate documentation with Swimm
- Use the
@askswimmcommand to generate documentation based on Copilot's response.
4. Swimm creates a draft PR
- Swimm generates a draft pull request with a placeholder for your document.
5. Documentation is automatically updated
- Swimm keeps your documentation in sync with any changes to the codebase, ensuring it remains up-to-date.
This document is automatically kept up to date using Swimm.