← Back to Documentation

Getting Started

Set up Benlon in 30 minutes and start generating living documentation.

Prerequisites

Before you begin, make sure you have:

  • A Benlon account (sign up at benlon.com)
  • Access to your code repositories (GitHub, GitLab, or Bitbucket)
  • Admin permissions for the repositories you want to connect

Step 1: Create Your Workspace

  1. Sign in to your Benlon account
  2. Click "Create Workspace" from the dashboard
  3. Enter your workspace name and select your team size
  4. Click "Create"

Your workspace is the central hub where all your documentation lives. You can create multiple workspaces for different teams or projects.

Step 2: Connect Your Repository

  1. Navigate to "Settings" → "Integrations"
  2. Click "Connect GitHub" (or your preferred provider)
  3. Authorize Benlon to access your repositories
  4. Select the repositories you want to connect
  5. Click "Connect Repositories"

Note: Benlon requests read-only access by default. We never modify, delete, or push changes to your repositories.

Step 3: Configure Your First Project

  1. Click on the repository you just connected
  2. Choose which branches to track (default: main/master)
  3. Select the programming languages and frameworks
  4. Configure documentation preferences (style, format, level of detail)
  5. Click "Start Analysis"

Benlon will now analyze your codebase. Depending on the size, this can take 5-30 minutes for the initial analysis.

Step 4: Review Generated Documentation

Once the analysis is complete, you'll see your first documentation:

  • API Reference: Automatically generated from your code and schemas
  • Architecture Overview: A visual map of your services and dependencies
  • Getting Started Guide: Auto-generated setup instructions
  • Common Workflows: Identified patterns and use cases

Review the generated content and make any necessary adjustments. You can edit, reorganize, or supplement the documentation as needed.

Step 5: Invite Your Team

  1. Go to "Settings" → "Team Members"
  2. Click "Invite Member"
  3. Enter email addresses and assign roles
  4. Click "Send Invitations"

Team members will receive an invitation email and can start accessing the documentation immediately after accepting.

Step 6: Set Up Auto-Sync

Enable automatic documentation updates when your code changes:

  1. Navigate to your project settings
  2. Go to "Auto-Sync" tab
  3. Enable "Automatic Updates"
  4. Configure sync triggers (e.g., on push, on merge to main)
  5. Set review preferences (auto-update vs. propose changes)

With auto-sync enabled, Benlon will detect code changes and update your documentation automatically, ensuring it stays current.

Next Steps

API Reference

Integrate Benlon into your workflows

Need Help?

If you run into any issues or have questions, we're here to help:

Contact Support