Driver Docs Overview

Overview

Driver's automated documentation platform intelligently analyzes codebases, generates contextual documentation, and maintains it across changes. Driver Docs are automatically generated for each codebase you onboard. If you haven't already, first read the guide to connecting a codebase.

Generating Documentation

1. Navigate to the Library.

2. Search or browse for the codebase whose Driver Docs you want to generate.

3. Select one or more codebases, and click on the Generate Docs button.

4. Review and confirm the projected computed line usage. If you don't need Driver to generate documentation for all files in a codebase, you can exclude specific files using a .driverignore file.

Viewing Driver Docs

1. Navigate to the Library.

2. Search or browse for the codebase whose Driver Docs you want to view.
   
   

   

   
   

3. Click on the codebase name.

You can also navigate to a codebase's Driver Docs by clicking on the codebase name in the homepage or in the list of sources on a Page in Driver Studio.

Navigate Driver Docs

1. Select the file or folder to load the respective Driver Docs. You can use the search bar to filter by file type or keyword.
   
   

   

   
   

2. Click on the column of horizontal lines on the left side of any Driver Doc to view the table of contents. Clicking on an entry in the table will navigate to that section.
   
   

   

   
   

   

   
   
   

3. Expand or collapse the code preview on the right side of the screen by clicking on the arrow.
   
   

   

   
   

4. View symbol documentation for a source file by clicking on the various symbol tabs near the top of the Driver Doc.
   
   

   

   
   

Language Specialization

The format and content of Driver Docs is specialized for specific languages. For example, in Verilog/SystemVerilog, it's essential to document modules, while in C it is important to document Data Structures.

Here is a list of languages that include specialization. If you would like to request specialization for a language not listed here, send us a note at support@driver.ai.

1. Arduino C++ Variant (.ino filetypes)

2. Assembly

3. C

4. C#

5. C++

6. Java

7. Javascript

8. PHP

9. Python

10. Ruby

11. Rust

12. Terraform

13. Typescript

14. VB6

15. Verilog/SystemVerilog