Connecting a Codebase

Connect Your Content Sources

You can connect both codebases and PDFs to Driver using the "Add new source" button on the homepage.

Connecting a Codebase

There are two ways to add a codebase to Driver.

1. Driver analyzes your code directly by connecting to GitHub. If you connect your codebases this way, Driver will automatically keep documentation up-to-date.

2. Alternatively, you can add a .zip archive of a codebase to Driver, which is sometimes helpful. In this case, Driver cannot automatically keep documentation up-to-date.

You can choose the best approach for you by selecting either "Git Integration" or "Upload."

Connecting to GitHub

Driver provides applications to integrate with GitHub and other version control systems. You can easily manage which repositories Driver can access in GitHub's "Settings" page by navigating to "Applications."

Understanding Usage

Once a codebase is connected, Driver will analyze the content of the codebase, including the total lines of source code, file count, excluded files, and codebase size. Driver Docs charges based on the volume of source code uploaded.

Limiting Analysis with a .driverignore

You may not want all of the content of your codebase to be analyzed. You can include a .driverignore file as part of your codebase to specify files, file types, and folders to exclude from processing. The semantics are the same as .gitignore.

# Ignore a file:
directory_name/file_name.c

# Ignore a file type:
*.c

# Ignore an entire directory:
directory_name