Pilot Instructions

This guide provides comprehensive setup instructions for Swimm pilots, covering both On-Demand Documentation and Bulk Auto-generated Documentation as a service. Follow these steps to get started with your Swimm pilot.

Overview​

Swimm offers two primary use cases for documentation:

1. On-Demand Documentation - Create documentation as needed for specific code sections, features, or workflows.
2. Bulk Auto-generated Documentation - Swimm helps you automatically generate documentation in bulk for large portions of your codebase as a service.

Both options can be deployed in cloud or on-premises environments, depending on your organization's requirements.

Deployment Options​

Cloud Deployment​

Cloud deployment is the quickest way to get started with Swimm. Your code remains in your repositories while Swimm provides the documentation platform.

Connect Cloud Git Hosting​

Swimm integrates seamlessly with major cloud git hosting providers:

Provider	Setup Guide
GitHub	Connect GitHub Repositories
GitLab	Connect GitLab Repositories
Bitbucket	Connect Bitbucket Repositories
Azure DevOps	Connect Azure Repositories

On-Premises Deployment​

For organizations with strict security requirements or self-hosted git solutions, Swimm offers comprehensive on-premises deployment options.

Self-Hosted Git Setup​

Configure Swimm with your self-hosted git provider:

Provider	Setup Guide
GitLab Enterprise	Create GitLab Enterprise OAuth Application
Bitbucket Data Center	Create Bitbucket OAuth Application

Kubernetes Deployment​

For on-premises Kubernetes deployment, follow these steps:

1. Prepare Kubernetes Environment

   • Ensure you have a running Kubernetes cluster
   • Set up necessary permissions and access controls

2. Deploy Swimm Agent

   • Edit the deployment.yaml template with your organization's registry URL and API keys
   • Configure service.yaml for network access
   • Deploy using kubectl commands

For detailed instructions, refer to our Kubernetes Deployment Guide.

On-Demand Documentation Setup​

On-Demand Documentation allows your developers to create documentation as needed during the development process.

Key Features​

• Interactive documentation creation with code snippets
• Real-time collaboration between team members
• Automatic documentation verification to ensure docs stay in sync with code
• Integration with existing development workflows

Getting Started​

1. Connect Repositories

   • Follow the appropriate guide above to connect your repositories
   • Select the repositories you want to document

2. Create Your First Document

   • Navigate to your repository in Swimm
   • Click "Create Document" to start documenting
   • Add code snippets, explanations, and context

3. Share with Your Team

   • Invite team members to collaborate
   • Set up permissions and access controls

Bulk Auto-generated Documentation​

Swimm's Bulk Auto-generated Documentation service uses AI to automatically generate comprehensive documentation for your codebase.

Key Features​

• AI-powered documentation generation
• Customizable documentation templates
• Batch processing for large codebases
• Continuous updates as your code evolves

Getting Started​

1. Prepare Your Codebase

   • Connect your repositories as described above
   • Identify the scope of documentation needed

2. Configure Documentation Parameters

   • Define documentation depth and coverage
   • Set up custom templates and style guides
   • Configure code analysis preferences

3. Generate Documentation

   • Initiate the bulk documentation generation process
   • Review and refine generated documentation
   • Publish to your team's documentation hub

Integration Options​

CI/CD Integration​

Integrate Swimm into your CI/CD pipeline to ensure documentation stays up-to-date:

# Example CI/CD configuration
steps:
  - name: Verify Swimm Documentation
    run: |
      curl -s https://releases.swimm.io/ci/latest/install | bash
      swimm verify

IDE Plugins​

Enhance your development experience with Swimm's IDE plugins:

• VS Code Extension
• JetBrains IDEs (IntelliJ, WebStorm, etc.)
• Visual Studio

Support and Resources​

• Community Slack Channel
• Getting Started Guide
• Security and Privacy Overview

For additional assistance with your pilot, contact your Swimm representative or reach out through our support channels.

---

Read this article on Swimm's official docsite